Cisco-IOS-XR-ipv6-ospfv3-oper API API Reference
API generated from Cisco-IOS-XR-ipv6-ospfv3-oper@2017-10-30.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/operational/network-topology:network-topology/topology/topology-netconf/node/{{node-name}}/yang-ext:mount/URL '/' code: %2F
Schemes: http
Version: 1.0.0
Paths
OSPFV3 - Retrieve
Retrieve operation of resource: ospfv3
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"processes": {
"process": [
{
"statistics": {
"issu-stats": {
"nsr-lsa-qad-mdata-count": "integer",
"nsr-nbr-init-sync-pend-count": "string",
"nsr-mtu": "integer",
"nsr-nbr-qad-mdata-count": "integer",
"nsr-conn-to-active-closes": "integer",
"nsr-conn-to-active-errors": "integer",
"nsr-nbr-seq-no": "integer",
"nsr-conn-to-active-opens": "integer",
"nsr-issu-milestone": [
{
"milestone-name": "string",
"milestone-status": "string"
}
],
"nsr-version": "integer",
"nsr-intf-seq-no": "integer",
"nsr-tmr-quant": "string",
"nsr-fsm-running-timer": [
"string"
],
"nsr-lsa-init-sync-pend-count": "string",
"nsr-peer-node-id": "integer",
"nsr-fsm-flag": [
"string"
],
"nsr-conn-to-active-attempts": "integer",
"nsr-conn-to-active-fails": "integer",
"nsr-peer-version": "integer",
"nsr-thd-stats": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-rtr-thd-sched": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-revision": "string",
"nsr-node-id": "integer",
"nsr-lsa-qad-qid": "integer",
"nsr-nbr-qad-qid": "integer",
"nsr-err-history": [
{
"nsr-error-info": [
null
]
}
]
},
"vrf-rib-batch-stats": {
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
}
}
]
}
}
PROCESSES - Retrieve
Retrieve operation of resource: processes
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"process": [
{
"statistics": {
"issu-stats": {
"nsr-lsa-qad-mdata-count": "integer",
"nsr-nbr-init-sync-pend-count": "string",
"nsr-mtu": "integer",
"nsr-nbr-qad-mdata-count": "integer",
"nsr-conn-to-active-closes": "integer",
"nsr-conn-to-active-errors": "integer",
"nsr-nbr-seq-no": "integer",
"nsr-conn-to-active-opens": "integer",
"nsr-issu-milestone": [
{
"milestone-name": "string",
"milestone-status": "string"
}
],
"nsr-version": "integer",
"nsr-intf-seq-no": "integer",
"nsr-tmr-quant": "string",
"nsr-fsm-running-timer": [
"string"
],
"nsr-lsa-init-sync-pend-count": "string",
"nsr-peer-node-id": "integer",
"nsr-fsm-flag": [
"string"
],
"nsr-conn-to-active-attempts": "integer",
"nsr-conn-to-active-fails": "integer",
"nsr-peer-version": "integer",
"nsr-thd-stats": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-rtr-thd-sched": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-revision": "string",
"nsr-node-id": "integer",
"nsr-lsa-qad-qid": "integer",
"nsr-nbr-qad-qid": "integer",
"nsr-err-history": [
{
"nsr-error-info": [
null
]
}
]
},
"vrf-rib-batch-stats": {
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
}
}
]
}
PROCESS - Retrieve
Retrieve operation of resource: process
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"issu-stats": {
"nsr-lsa-qad-mdata-count": "integer",
"nsr-nbr-init-sync-pend-count": "string",
"nsr-mtu": "integer",
"nsr-nbr-qad-mdata-count": "integer",
"nsr-conn-to-active-closes": "integer",
"nsr-conn-to-active-errors": "integer",
"nsr-nbr-seq-no": "integer",
"nsr-conn-to-active-opens": "integer",
"nsr-issu-milestone": [
{
"milestone-name": "string",
"milestone-status": "string"
}
],
"nsr-version": "integer",
"nsr-intf-seq-no": "integer",
"nsr-tmr-quant": "string",
"nsr-fsm-running-timer": [
"string"
],
"nsr-lsa-init-sync-pend-count": "string",
"nsr-peer-node-id": "integer",
"nsr-fsm-flag": [
"string"
],
"nsr-conn-to-active-attempts": "integer",
"nsr-conn-to-active-fails": "integer",
"nsr-peer-version": "integer",
"nsr-thd-stats": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-rtr-thd-sched": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-revision": "string",
"nsr-node-id": "integer",
"nsr-lsa-qad-qid": "integer",
"nsr-nbr-qad-qid": "integer",
"nsr-err-history": [
{
"nsr-error-info": [
{}
]
}
]
},
"vrf-rib-batch-stats": {
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
}
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"vrf-name": "string",
"neighbor-detail-process-table": {
"neighbor-detail": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf-name": "string",
"neighbor-detail-process-table": {
"neighbor-detail": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
}
SUMMARY-PREFIXES - Retrieve
Retrieve operation of resource: summary-prefixes
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary-prefix": [
{
"prefix-metric": "integer",
"prefix-metric-type": "string",
"tag": "integer"
}
]
}
SUMMARY-PREFIX - Retrieve
Retrieve operation of resource: summary-prefix
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-metric": "integer",
"prefix-metric-type": "string",
"tag": "integer"
}
BORDER-ROUTERS - Retrieve
Retrieve operation of resource: border-routers
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"border-router": [
{
"border-router-path": [
{
"interface-name": "string",
"border-router-area-id": "string",
"border-router-type": "string",
"border-router-next-hop": "string",
"border-router-route-metric": "integer",
"spf-version": "integer",
"is-intra-area-router": "boolean"
}
]
}
]
}
BORDER-ROUTER - Retrieve
Retrieve operation of resource: border-router
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
border-router-id
in path
string
ID of border-router-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"border-router-path": [
{
"interface-name": "string",
"border-router-area-id": "string",
"border-router-type": "string",
"border-router-next-hop": "string",
"border-router-route-metric": "integer",
"spf-version": "integer",
"is-intra-area-router": "boolean"
}
]
}
BORDER-ROUTER-PATH - Retrieve
Retrieve operation of resource: border-router-path
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
border-router-id
in path
string
ID of border-router-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"border-router-area-id": "string",
"border-router-type": "string",
"border-router-next-hop": "string",
"border-router-route-metric": "integer",
"spf-version": "integer",
"is-intra-area-router": "boolean"
}
SHAM-LINK-TABLE - Retrieve
Retrieve operation of resource: sham-link-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"virtual-link-authentication-spi": "integer",
"is-sham-link-ip-security-active": "boolean",
"sham-link-last-gr": "integer",
"sham-link-retransmission-interval": "integer",
"sham-link-area": "string",
"is-sham-link-ip-security-required": "boolean",
"sham-link-demand-circuit": "boolean",
"sham-link-ifindex": "integer",
"sham-link-encryption-transmitted": "integer",
"sham-link-authentication-transmit": "integer",
"sham-link-neighbor": {
"sham-link-state": "string",
"sham-link-suppress-hello": "boolean",
"sham-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
},
"sham-link-dest-address": "string",
"sham-link-dc-bitless-lsa": "integer",
"sham-link-encryption-spi": "integer",
"sham-link-dead-interval": "integer",
"sham-link-wait-interval": "integer",
"is-sham-link-authentication-enabled": "boolean",
"sham-link-neighbor-id": "string",
"sham-link-next-hello": "integer",
"sham-link-gr-enabled": "boolean",
"sham-link-transmission-delay": "integer",
"sham-link-cost": "integer",
"sham-link-gr": "boolean",
"sham-link-passive": "boolean",
"sham-link-encrypted-authentication-transmitted": "integer",
"is-sham-link-encryption-enabled": "boolean",
"sham-link-hello-interval": "integer",
"sham-link-state": "string",
"sham-link-source-address": "string"
}
SHAM-LINK-NEIGHBOR - Retrieve
Retrieve operation of resource: sham-link-neighbor
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sham-link-state": "string",
"sham-link-suppress-hello": "boolean",
"sham-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
}
SHAM-LINK-RETRANSMISSION - Retrieve
Retrieve operation of resource: sham-link-retransmission
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
AREA-INFORMATIONS - Retrieve
Retrieve operation of resource: area-informations
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-information": [
{
"is-area-stubbed": "boolean",
"is-rrr-enabled": "boolean",
"area-lfa-revision": "integer",
"is-nssa-translated": "boolean",
"indication-ls-as": "integer",
"is-area-nssa": "boolean",
"is-backbone-area-active": "boolean",
"area-lfa-interface-count": "integer",
"area-interfaces": "integer",
"is-area-total-stubbed": "boolean",
"area-opaque-lsas": "integer",
"is-nssa-translated-always": "boolean",
"flood-list-length": "integer",
"stub-default-cost": "integer",
"is-nssa-default": "boolean",
"sp-fs": "integer",
"area-per-prefix-lfa-interface-count": "integer",
"area-opaque-lsa-checksum": "integer",
"nssa-no-redistribution": "boolean",
"area-range": [
{
"range-prefix": "string",
"net-cost": "integer",
"range-prefix-length": "integer",
"status": "string",
"is-cost-configured": "boolean"
}
],
"area-dc-bitless-ls-as": "integer",
"do-not-age-ls-as": "integer"
}
]
}
AREA-INFORMATION - Retrieve
Retrieve operation of resource: area-information
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-area-stubbed": "boolean",
"is-rrr-enabled": "boolean",
"area-lfa-revision": "integer",
"is-nssa-translated": "boolean",
"indication-ls-as": "integer",
"is-area-nssa": "boolean",
"is-backbone-area-active": "boolean",
"area-lfa-interface-count": "integer",
"area-interfaces": "integer",
"is-area-total-stubbed": "boolean",
"area-opaque-lsas": "integer",
"is-nssa-translated-always": "boolean",
"flood-list-length": "integer",
"stub-default-cost": "integer",
"is-nssa-default": "boolean",
"sp-fs": "integer",
"area-per-prefix-lfa-interface-count": "integer",
"area-opaque-lsa-checksum": "integer",
"nssa-no-redistribution": "boolean",
"area-range": [
{
"range-prefix": "string",
"net-cost": "integer",
"range-prefix-length": "integer",
"status": "string",
"is-cost-configured": "boolean"
}
],
"area-dc-bitless-ls-as": "integer",
"do-not-age-ls-as": "integer"
}
AREA-RANGE - Retrieve
Retrieve operation of resource: area-range
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range-prefix": "string",
"net-cost": "integer",
"range-prefix-length": "integer",
"status": "string",
"is-cost-configured": "boolean"
}
DATABASE-TABLE - Retrieve
Retrieve operation of resource: database-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-table": {
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer"
}
}
}
}
]
}
}
LSA-TABLE - Retrieve
Retrieve operation of resource: lsa-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean"
}
}
}
}
]
}
LSA - Retrieve
Retrieve operation of resource: lsa
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
}
}
LSA-INFO - Retrieve
Retrieve operation of resource: lsa-info
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean"
}
}
LSA-SUMMARY-INFO - Retrieve
Retrieve operation of resource: lsa-summary-info
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-router-id": "integer",
"prefix-length": "integer",
"interface-name": "string",
"links": "integer",
"is-virtual-link": "boolean",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"reference-lsa-id": "integer",
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": "string",
"reference-type": "integer",
"router-la-bits": "integer",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: router-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link": [
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
],
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"router-la-bits": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"rpf-path": {
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
LINK - Retrieve
Retrieve operation of resource: link
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
NETWORK-LSA-TYPE - Retrieve
Retrieve operation of resource: network-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"neighbor-router": [
"string"
],
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-prefix-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"prefix": "string",
"prefix-length": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-router-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"lsa-router-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
EXTERNAL-LSA-TYPE - Retrieve
Retrieve operation of resource: external-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
NSSALSA-TYPE - Retrieve
Retrieve operation of resource: nssalsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: link-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"router-priority": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"lsa-link-local": "string",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
INTRA-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: intra-area-prefix-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reference-lsa-id": "integer",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"reference-advertised-router": "string",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"reference-type": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
GRACE-LSA - Retrieve
Retrieve operation of resource: grace-lsa
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer",
"grace-reason": "string"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-link-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-AREA-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-area-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-ASLSA-TYPE - Retrieve
Retrieve operation of resource: unknown-aslsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
LSA-INTERNAL-TABLE - Retrieve
Retrieve operation of resource: lsa-internal-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean"
}
}
}
}
]
}
LSA - Retrieve
Retrieve operation of resource: lsa
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
}
}
LSA-INFO - Retrieve
Retrieve operation of resource: lsa-info
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean"
}
}
LSA-SUMMARY-INFO - Retrieve
Retrieve operation of resource: lsa-summary-info
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-router-id": "integer",
"prefix-length": "integer",
"interface-name": "string",
"links": "integer",
"is-virtual-link": "boolean",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"reference-lsa-id": "integer",
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": "string",
"reference-type": "integer",
"router-la-bits": "integer",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: router-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link": [
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
],
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"router-la-bits": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"rpf-path": {
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
LINK - Retrieve
Retrieve operation of resource: link
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
NETWORK-LSA-TYPE - Retrieve
Retrieve operation of resource: network-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"neighbor-router": [
"string"
],
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-prefix-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"prefix": "string",
"prefix-length": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-router-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"lsa-router-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
EXTERNAL-LSA-TYPE - Retrieve
Retrieve operation of resource: external-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
NSSALSA-TYPE - Retrieve
Retrieve operation of resource: nssalsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: link-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"router-priority": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"lsa-link-local": "string",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
INTRA-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: intra-area-prefix-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reference-lsa-id": "integer",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"reference-advertised-router": "string",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"reference-type": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
GRACE-LSA - Retrieve
Retrieve operation of resource: grace-lsa
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer",
"grace-reason": "string"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-link-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-AREA-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-area-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-ASLSA-TYPE - Retrieve
Retrieve operation of resource: unknown-aslsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTERFACE-PROCESS-TABLE - Retrieve
Retrieve operation of resource: interface-process-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"dead-interval": "integer",
"interface-bfd": {
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
},
"interface-encrypted-authentication-transmitted": "integer",
"network-type": "string",
"is-interface-encryption-enabled": "boolean",
"interface-references": "integer",
"backup-designated-router-address": "string",
"is-interface-ip-security-active": "boolean",
"interface-link-cost": "integer",
"interface-address": "string",
"adjacent-neighbor": "integer",
"configured-ldp-sync": "boolean",
"interface-number": "integer",
"designated-router-address": "string",
"transmission-delay": "integer",
"interface-router-id": "string",
"interface-ldp-sync": "boolean",
"interface-dc-bitless-ls-as": "integer",
"ospf-interface-state": "string",
"designated-router-id": "string",
"is-prefix-suppress": "boolean",
"is-interface-lsa-filtered": "boolean",
"hello-interval": "integer",
"next-hello-time": "integer",
"interface-neighbor": [
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
],
"network-lsa-flush-timer": "integer",
"is-interface-demand-circuit": "boolean",
"interface-encryption-transmitted": "integer",
"interface-state": "string",
"wait-interval": "integer",
"is-designated-router": "boolean",
"active-interface": {
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
},
"backup-designated-router-id": "string",
"is-interface-flood-reduction": "boolean",
"is-demand-circuit-configured": "boolean",
"interface-retransmission-interval": "integer",
"interface-authentication-spi": "integer",
"interface-encryption-spi": "integer",
"interface-authentication-transmit": "integer",
"interface-priority": "integer",
"is-interface-line-up": "boolean",
"is-interface-ip-security-required": "boolean"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dead-interval": "integer",
"interface-bfd": {
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
},
"interface-encrypted-authentication-transmitted": "integer",
"network-type": "string",
"is-interface-encryption-enabled": "boolean",
"interface-references": "integer",
"backup-designated-router-address": "string",
"is-interface-ip-security-active": "boolean",
"interface-link-cost": "integer",
"interface-address": "string",
"adjacent-neighbor": "integer",
"configured-ldp-sync": "boolean",
"interface-number": "integer",
"designated-router-address": "string",
"transmission-delay": "integer",
"interface-router-id": "string",
"interface-ldp-sync": "boolean",
"interface-dc-bitless-ls-as": "integer",
"ospf-interface-state": "string",
"designated-router-id": "string",
"is-prefix-suppress": "boolean",
"is-interface-lsa-filtered": "boolean",
"hello-interval": "integer",
"next-hello-time": "integer",
"interface-neighbor": [
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
],
"network-lsa-flush-timer": "integer",
"is-interface-demand-circuit": "boolean",
"interface-encryption-transmitted": "integer",
"interface-state": "string",
"wait-interval": "integer",
"is-designated-router": "boolean",
"active-interface": {
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
},
"backup-designated-router-id": "string",
"is-interface-flood-reduction": "boolean",
"is-demand-circuit-configured": "boolean",
"interface-retransmission-interval": "integer",
"interface-authentication-spi": "integer",
"interface-encryption-spi": "integer",
"interface-authentication-transmit": "integer",
"interface-priority": "integer",
"is-interface-line-up": "boolean",
"is-interface-ip-security-required": "boolean"
}
ACTIVE-INTERFACE - Retrieve
Retrieve operation of resource: active-interface
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
}
INTERFACE-BFD - Retrieve
Retrieve operation of resource: interface-bfd
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
}
INTERFACE-NEIGHBOR - Retrieve
Retrieve operation of resource: interface-neighbor
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
REDISTRIBUTIONS - Retrieve
Retrieve operation of resource: redistributions
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"redistribution": [
{
"red-metric": "integer",
"policy-name": "string",
"red-tag": "integer",
"red-metric-type": "integer",
"red-metric-flag": "boolean",
"red-mtype-flag": "boolean",
"process-id": "string",
"protocol-name-xr": "string"
}
]
}
REDISTRIBUTION - Retrieve
Retrieve operation of resource: redistribution
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"red-metric": "integer",
"policy-name": "string",
"red-tag": "integer",
"red-metric-type": "integer",
"red-metric-flag": "boolean",
"red-mtype-flag": "boolean",
"process-id": "string",
"protocol-name-xr": "string"
}
EXTERNAL-ROUTES - Retrieve
Retrieve operation of resource: external-routes
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"external-route": [
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-extended-community": {
"extended-community-domain-id-value": "string",
"extended-community-area-id": "integer",
"extended-community-router-id": "string",
"extended-community-route-type": "integer",
"extended-community-options": "integer",
"extended-communityl-domain-id-type": "integer"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
]
}
EXTERNAL-ROUTE - Retrieve
Retrieve operation of resource: external-route
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-extended-community": {
"extended-community-domain-id-value": "string",
"extended-community-area-id": "integer",
"extended-community-router-id": "string",
"extended-community-route-type": "integer",
"extended-community-options": "integer",
"extended-communityl-domain-id-type": "integer"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
ROUTE-TOPOLOGY - Retrieve
Retrieve operation of resource: route-topology
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
}
ROUTE-EXTENDED-COMMUNITY - Retrieve
Retrieve operation of resource: route-extended-community
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-community-domain-id-value": "string",
"extended-community-area-id": "integer",
"extended-community-router-id": "string",
"extended-community-route-type": "integer",
"extended-community-options": "integer",
"extended-communityl-domain-id-type": "integer"
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
ROUTE-BACKUP-PATH - Retrieve
Retrieve operation of resource: route-backup-path
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
}
NEIGHBOR-NEXT-HOP - Retrieve
Retrieve operation of resource: neighbor-next-hop
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-next-hop-intf-index": "integer"
}
REQUEST-LIST-PROCESS-TABLE - Retrieve
Retrieve operation of resource: request-list-process-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request": [
{
"neighbor-address": "string",
"interface-name": "string",
"request-virtual-link-id": "integer",
"request": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"request-neighbor-address": "string",
"request-sham-link-id": "integer",
"is-request-sham-link": "boolean",
"is-request-virtual-link": "boolean"
}
]
}
REQUEST - Retrieve
Retrieve operation of resource: request
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-virtual-link-id": "integer",
"request": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"request-neighbor-address": "string",
"request-sham-link-id": "integer",
"is-request-sham-link": "boolean",
"is-request-virtual-link": "boolean"
}
REQUEST - Retrieve
Retrieve operation of resource: request
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
VIRTUAL-LINK - Retrieve
Retrieve operation of resource: virtual-link
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-virtual-link-ip-security-required": "boolean",
"virtual-link-dc-bitless-lsa": "integer",
"virtual-link-cost": "integer",
"virtual-link-neighbor-id": "string",
"virtual-link-encrypted-authentication-transmitted": "integer",
"virtual-link-next-hello": "integer",
"virtual-link-dead-interval": "integer",
"is-virtual-link-demand-circuit": "boolean",
"virtual-link-hello-interval": "integer",
"virtual-link-state": "string",
"virtual-link-encryption-spi": "integer",
"virtual-link-wait-interval": "integer",
"virtual-link-neighbor": {
"virtual-link-state": "string",
"is-virtual-link-hello-suppressed": "boolean",
"virtual-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
},
"virtual-link-authentication-spi": "integer",
"virtual-link-retransmission-interval": "integer",
"virtual-link-encryption-transmitted": "integer",
"is-virtual-link-encryption-enabled": "boolean",
"virtual-link-neighbor-address": "string",
"transit-area-id": "string",
"is-virtual-link-authentication-enabled": "boolean",
"interface-name": "string",
"virual-link-transmission-delay": "integer",
"virtual-link-authentication-transmit": "integer",
"is-virtual-link-ip-security-active": "boolean",
"is-virtual-link-passive": "boolean",
"virtual-link-interface-number": "integer"
}
VIRTUAL-LINK-NEIGHBOR - Retrieve
Retrieve operation of resource: virtual-link-neighbor
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"virtual-link-state": "string",
"is-virtual-link-hello-suppressed": "boolean",
"virtual-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
}
VIRTUAL-LINK-RETRANSMISSION - Retrieve
Retrieve operation of resource: virtual-link-retransmission
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
FLOOD-LIST-PROCESS-TABLE - Retrieve
Retrieve operation of resource: flood-list-process-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flood": [
{
"interface-name": "string",
"queue-length": "integer",
"as-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"area-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"ls-transmission-timer": "integer",
"link-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
]
}
]
}
FLOOD - Retrieve
Retrieve operation of resource: flood
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"queue-length": "integer",
"as-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"area-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"ls-transmission-timer": "integer",
"link-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
]
}
LINK-FLOOD - Retrieve
Retrieve operation of resource: link-flood
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
AREA-FLOOD - Retrieve
Retrieve operation of resource: area-flood
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
AS-FLOOD - Retrieve
Retrieve operation of resource: as-flood
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
ROUTE-SUMMARY - Retrieve
Retrieve operation of resource: route-summary
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-sent-route": "integer",
"inter-area-route": "integer",
"nssa-two-route": "integer",
"extern-two-route": "integer",
"route-connected": "integer",
"redistribution-route": "integer",
"intra-area-route": "integer",
"nssa-one-route": "integer",
"extern-one-route": "integer",
"total-received-route": "integer",
"route-id": "string"
}
AREAS - Retrieve
Retrieve operation of resource: areas
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area": [
{
"database-summary-table": {
"database-summary": {
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
}
}
]
}
AREA - Retrieve
Retrieve operation of resource: area
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database-summary-table": {
"database-summary": {
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
}
}
NEIGHBOR-DETAIL-TABLE - Retrieve
Retrieve operation of resource: neighbor-detail-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-detail": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: neighbor-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: neighbor-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
}
NEIGHBOR-RETRANSMISSION - Retrieve
Retrieve operation of resource: neighbor-retransmission
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
NEIGHBOR-BFD-INFO - Retrieve
Retrieve operation of resource: neighbor-bfd-info
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
}
INTERFACE-BRIEF-TABLE - Retrieve
Retrieve operation of resource: interface-brief-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-brief": [
{
"interface-name": "string",
"interface-neighbors": "integer",
"interface-link-cost": "integer",
"interface-adjacent-neighbors": "integer",
"interface-address": "string",
"network-type": "string",
"ospf-interface-state": "string"
}
]
}
INTERFACE-BRIEF - Retrieve
Retrieve operation of resource: interface-brief
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbors": "integer",
"interface-link-cost": "integer",
"interface-adjacent-neighbors": "integer",
"interface-address": "string",
"network-type": "string",
"ospf-interface-state": "string"
}
REQUEST-LIST-TABLE - Retrieve
Retrieve operation of resource: request-list-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request": [
{
"neighbor-address": "string",
"interface-name": "string",
"request-virtual-link-id": "integer",
"request": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"request-neighbor-address": "string",
"request-sham-link-id": "integer",
"is-request-sham-link": "boolean",
"is-request-virtual-link": "boolean"
}
]
}
REQUEST - Retrieve
Retrieve operation of resource: request
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-virtual-link-id": "integer",
"request": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"request-neighbor-address": "string",
"request-sham-link-id": "integer",
"is-request-sham-link": "boolean",
"is-request-virtual-link": "boolean"
}
REQUEST - Retrieve
Retrieve operation of resource: request
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
NEIGHBOR-TABLE - Retrieve
Retrieve operation of resource: neighbor-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: neighbor-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
}
NEIGHBOR-RETRANSMISSION - Retrieve
Retrieve operation of resource: neighbor-retransmission
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
NEIGHBOR-BFD-INFO - Retrieve
Retrieve operation of resource: neighbor-bfd-info
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"dead-interval": "integer",
"interface-bfd": {
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
},
"interface-encrypted-authentication-transmitted": "integer",
"network-type": "string",
"is-interface-encryption-enabled": "boolean",
"interface-references": "integer",
"backup-designated-router-address": "string",
"is-interface-ip-security-active": "boolean",
"interface-link-cost": "integer",
"interface-address": "string",
"adjacent-neighbor": "integer",
"configured-ldp-sync": "boolean",
"interface-number": "integer",
"designated-router-address": "string",
"transmission-delay": "integer",
"interface-router-id": "string",
"interface-ldp-sync": "boolean",
"interface-dc-bitless-ls-as": "integer",
"ospf-interface-state": "string",
"designated-router-id": "string",
"is-prefix-suppress": "boolean",
"is-interface-lsa-filtered": "boolean",
"hello-interval": "integer",
"next-hello-time": "integer",
"interface-neighbor": [
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
],
"network-lsa-flush-timer": "integer",
"is-interface-demand-circuit": "boolean",
"interface-encryption-transmitted": "integer",
"interface-state": "string",
"wait-interval": "integer",
"is-designated-router": "boolean",
"active-interface": {
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
},
"backup-designated-router-id": "string",
"is-interface-flood-reduction": "boolean",
"is-demand-circuit-configured": "boolean",
"interface-retransmission-interval": "integer",
"interface-authentication-spi": "integer",
"interface-encryption-spi": "integer",
"interface-authentication-transmit": "integer",
"interface-priority": "integer",
"is-interface-line-up": "boolean",
"is-interface-ip-security-required": "boolean"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dead-interval": "integer",
"interface-bfd": {
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
},
"interface-encrypted-authentication-transmitted": "integer",
"network-type": "string",
"is-interface-encryption-enabled": "boolean",
"interface-references": "integer",
"backup-designated-router-address": "string",
"is-interface-ip-security-active": "boolean",
"interface-link-cost": "integer",
"interface-address": "string",
"adjacent-neighbor": "integer",
"configured-ldp-sync": "boolean",
"interface-number": "integer",
"designated-router-address": "string",
"transmission-delay": "integer",
"interface-router-id": "string",
"interface-ldp-sync": "boolean",
"interface-dc-bitless-ls-as": "integer",
"ospf-interface-state": "string",
"designated-router-id": "string",
"is-prefix-suppress": "boolean",
"is-interface-lsa-filtered": "boolean",
"hello-interval": "integer",
"next-hello-time": "integer",
"interface-neighbor": [
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
],
"network-lsa-flush-timer": "integer",
"is-interface-demand-circuit": "boolean",
"interface-encryption-transmitted": "integer",
"interface-state": "string",
"wait-interval": "integer",
"is-designated-router": "boolean",
"active-interface": {
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
},
"backup-designated-router-id": "string",
"is-interface-flood-reduction": "boolean",
"is-demand-circuit-configured": "boolean",
"interface-retransmission-interval": "integer",
"interface-authentication-spi": "integer",
"interface-encryption-spi": "integer",
"interface-authentication-transmit": "integer",
"interface-priority": "integer",
"is-interface-line-up": "boolean",
"is-interface-ip-security-required": "boolean"
}
ACTIVE-INTERFACE - Retrieve
Retrieve operation of resource: active-interface
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
}
INTERFACE-BFD - Retrieve
Retrieve operation of resource: interface-bfd
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
}
INTERFACE-NEIGHBOR - Retrieve
Retrieve operation of resource: interface-neighbor
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
FLOOD-LIST-TABLE - Retrieve
Retrieve operation of resource: flood-list-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flood": [
{
"interface-name": "string",
"queue-length": "integer",
"as-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"area-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"ls-transmission-timer": "integer",
"link-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
]
}
]
}
FLOOD - Retrieve
Retrieve operation of resource: flood
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"queue-length": "integer",
"as-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"area-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"ls-transmission-timer": "integer",
"link-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
]
}
LINK-FLOOD - Retrieve
Retrieve operation of resource: link-flood
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
AREA-FLOOD - Retrieve
Retrieve operation of resource: area-flood
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
AS-FLOOD - Retrieve
Retrieve operation of resource: as-flood
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
RETRANSMISSION-LIST-TABLE - Retrieve
Retrieve operation of resource: retransmission-list-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retransmission": [
{
"neighbor-address": "string",
"interface-name": "string",
"retransmission-area-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-asdb": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-timer": "integer",
"is-retransmissionvirtual-link": "boolean",
"retransmission-length": "integer",
"is-retransmission-sham-link": "boolean",
"retransmissionvirtual-link-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-neighbor-address": "string",
"retransmission-sham-link-id": "integer",
"retransmissionvirtual-link-id": "integer"
}
]
}
RETRANSMISSION - Retrieve
Retrieve operation of resource: retransmission
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retransmission-area-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-asdb": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-timer": "integer",
"is-retransmissionvirtual-link": "boolean",
"retransmission-length": "integer",
"is-retransmission-sham-link": "boolean",
"retransmissionvirtual-link-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-neighbor-address": "string",
"retransmission-sham-link-id": "integer",
"retransmissionvirtual-link-id": "integer"
}
RETRANSMISSIONVIRTUAL-LINK-DB - Retrieve
Retrieve operation of resource: retransmissionvirtual-link-db
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
RETRANSMISSION-AREA-DB - Retrieve
Retrieve operation of resource: retransmission-area-db
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
RETRANSMISSION-ASDB - Retrieve
Retrieve operation of resource: retransmission-asdb
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
DATABASE-TABLE - Retrieve
Retrieve operation of resource: database-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-table": {
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer"
}
}
}
}
]
}
}
LSA-TABLE - Retrieve
Retrieve operation of resource: lsa-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean"
}
}
}
}
]
}
LSA - Retrieve
Retrieve operation of resource: lsa
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
}
}
LSA-INFO - Retrieve
Retrieve operation of resource: lsa-info
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean"
}
}
LSA-SUMMARY-INFO - Retrieve
Retrieve operation of resource: lsa-summary-info
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-router-id": "integer",
"prefix-length": "integer",
"interface-name": "string",
"links": "integer",
"is-virtual-link": "boolean",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"reference-lsa-id": "integer",
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": "string",
"reference-type": "integer",
"router-la-bits": "integer",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: router-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link": [
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
],
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"router-la-bits": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"rpf-path": {
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
LINK - Retrieve
Retrieve operation of resource: link
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
NETWORK-LSA-TYPE - Retrieve
Retrieve operation of resource: network-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"neighbor-router": [
"string"
],
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-prefix-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"prefix": "string",
"prefix-length": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-router-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"lsa-router-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
EXTERNAL-LSA-TYPE - Retrieve
Retrieve operation of resource: external-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
NSSALSA-TYPE - Retrieve
Retrieve operation of resource: nssalsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: link-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"router-priority": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"lsa-link-local": "string",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
INTRA-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: intra-area-prefix-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reference-lsa-id": "integer",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"reference-advertised-router": "string",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"reference-type": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
GRACE-LSA - Retrieve
Retrieve operation of resource: grace-lsa
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer",
"grace-reason": "string"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-link-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-AREA-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-area-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-ASLSA-TYPE - Retrieve
Retrieve operation of resource: unknown-aslsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
LSA-INTERNAL-TABLE - Retrieve
Retrieve operation of resource: lsa-internal-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean"
}
}
}
}
]
}
LSA - Retrieve
Retrieve operation of resource: lsa
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
}
}
LSA-INFO - Retrieve
Retrieve operation of resource: lsa-info
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean"
}
}
LSA-SUMMARY-INFO - Retrieve
Retrieve operation of resource: lsa-summary-info
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-router-id": "integer",
"prefix-length": "integer",
"interface-name": "string",
"links": "integer",
"is-virtual-link": "boolean",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"reference-lsa-id": "integer",
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": "string",
"reference-type": "integer",
"router-la-bits": "integer",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: router-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link": [
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
],
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"router-la-bits": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"rpf-path": {
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
LINK - Retrieve
Retrieve operation of resource: link
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
NETWORK-LSA-TYPE - Retrieve
Retrieve operation of resource: network-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"neighbor-router": [
"string"
],
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-prefix-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"prefix": "string",
"prefix-length": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-router-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"lsa-router-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
EXTERNAL-LSA-TYPE - Retrieve
Retrieve operation of resource: external-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
NSSALSA-TYPE - Retrieve
Retrieve operation of resource: nssalsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: link-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"router-priority": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"lsa-link-local": "string",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
INTRA-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: intra-area-prefix-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reference-lsa-id": "integer",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"reference-advertised-router": "string",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"reference-type": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
GRACE-LSA - Retrieve
Retrieve operation of resource: grace-lsa
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer",
"grace-reason": "string"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-link-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-AREA-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-area-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-ASLSA-TYPE - Retrieve
Retrieve operation of resource: unknown-aslsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-lsa-type
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
DATABASE-SUMMARY-TABLE - Retrieve
Retrieve operation of resource: database-summary-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database-summary": {
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
}
DATABASE-SUMMARY - Retrieve
Retrieve operation of resource: database-summary
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
DATABASE-COUNTERS - Retrieve
Retrieve operation of resource: database-counters
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
AREA-DATABASE - Retrieve
Retrieve operation of resource: area-database
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
AREA-DATABASE-SUMMARY - Retrieve
Retrieve operation of resource: area-database-summary
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
INTERNAL-ROUTES - Retrieve
Retrieve operation of resource: internal-routes
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"internal-route": [
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-source": [
{
"route-source-id": "string",
"route-source-lsa-type": "integer",
"route-source-adversting-router": "string"
}
],
"route-area-id": "integer",
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
]
}
INTERNAL-ROUTE - Retrieve
Retrieve operation of resource: internal-route
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-source": [
{
"route-source-id": "string",
"route-source-lsa-type": "integer",
"route-source-adversting-router": "string"
}
],
"route-area-id": "integer",
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
ROUTE-TOPOLOGY - Retrieve
Retrieve operation of resource: route-topology
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
}
ROUTE-SOURCE - Retrieve
Retrieve operation of resource: route-source
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-source-id": "string",
"route-source-lsa-type": "integer",
"route-source-adversting-router": "string"
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
ROUTE-BACKUP-PATH - Retrieve
Retrieve operation of resource: route-backup-path
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
}
NEIGHBOR-NEXT-HOP - Retrieve
Retrieve operation of resource: neighbor-next-hop
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-next-hop-intf-index": "integer"
}
PROTOCOL-AREAS - Retrieve
Retrieve operation of resource: protocol-areas
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-area": [
{
"protocol-interface": [
{
"distribute-list-in": "string",
"interface-name": "string"
}
],
"distribute-list-in": "string",
"protocol-area-id": "string"
}
]
}
PROTOCOL-AREA - Retrieve
Retrieve operation of resource: protocol-area
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-interface": [
{
"distribute-list-in": "string",
"interface-name": "string"
}
],
"distribute-list-in": "string",
"protocol-area-id": "string"
}
PROTOCOL-INTERFACE - Retrieve
Retrieve operation of resource: protocol-interface
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"distribute-list-in": "string",
"interface-name": "string"
}
CONNECTED-ROUTES - Retrieve
Retrieve operation of resource: connected-routes
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"connected-route": [
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
]
}
CONNECTED-ROUTE - Retrieve
Retrieve operation of resource: connected-route
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
ROUTE-TOPOLOGY - Retrieve
Retrieve operation of resource: route-topology
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
ROUTE-BACKUP-PATH - Retrieve
Retrieve operation of resource: route-backup-path
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
}
NEIGHBOR-NEXT-HOP - Retrieve
Retrieve operation of resource: neighbor-next-hop
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-next-hop-intf-index": "integer"
}
VRF-STATISTICS - Retrieve
Retrieve operation of resource: vrf-statistics
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf-rib-batch-stats": {
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
}
PROTOCOL-STATS - Retrieve
Retrieve operation of resource: protocol-stats
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-stat": [
{
"ls-req-in-packets": "integer",
"ls-upd-in-ignored": "integer",
"total-out-packets": "integer",
"ls-req-in-ls-as": "integer",
"ls-ack-out-packets": "integer",
"ls-req-out-packets": "integer",
"total-in-packets": "integer",
"ls-ack-in-ls-as": "integer",
"dropped-in-gs": "integer",
"dbdes-in-ls-as": "integer",
"ls-upd-out-ls-as": "integer",
"hello-out-packets": "integer",
"dbdes-out-ls-as": "integer",
"ls-upd-in-packets": "integer",
"checksum-err": "integer",
"ls-upd-out-packets": "integer",
"ls-req-out-ls-as": "integer",
"ls-upd-in-ls-as": "integer",
"dbdes-out-packets": "integer",
"ls-ack-in-packets": "integer",
"ls-ack-out-ls-as": "integer",
"hello-in-packets": "integer",
"dbdes-in-packets": "integer"
}
]
}
PROTOCOL-STAT - Retrieve
Retrieve operation of resource: protocol-stat
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ls-req-in-packets": "integer",
"ls-upd-in-ignored": "integer",
"total-out-packets": "integer",
"ls-req-in-ls-as": "integer",
"ls-ack-out-packets": "integer",
"ls-req-out-packets": "integer",
"total-in-packets": "integer",
"ls-ack-in-ls-as": "integer",
"dropped-in-gs": "integer",
"dbdes-in-ls-as": "integer",
"ls-upd-out-ls-as": "integer",
"hello-out-packets": "integer",
"dbdes-out-ls-as": "integer",
"ls-upd-in-packets": "integer",
"checksum-err": "integer",
"ls-upd-out-packets": "integer",
"ls-req-out-ls-as": "integer",
"ls-upd-in-ls-as": "integer",
"dbdes-out-packets": "integer",
"ls-ack-in-packets": "integer",
"ls-ack-out-ls-as": "integer",
"hello-in-packets": "integer",
"dbdes-in-packets": "integer"
}
SPF-STATS - Retrieve
Retrieve operation of resource: spf-stats
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spf-runtime": [
{
"rib-delete-routes": "integer",
"start-time": "integer",
"global-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"lsa": [
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
],
"lsa-changes": "string",
"reason-flags": "string",
"area-stat": [
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
],
"rib-add-routes": "integer"
}
],
"spf-header": {
"area-summary": [
{
"sp-fs": "integer",
"area-id": "integer"
}
],
"header-sp-fs": "integer",
"header-router-id": "string"
}
}
SPF-HEADER - Retrieve
Retrieve operation of resource: spf-header
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-summary": [
{
"sp-fs": "integer",
"area-id": "integer"
}
],
"header-sp-fs": "integer",
"header-router-id": "string"
}
AREA-SUMMARY - Retrieve
Retrieve operation of resource: area-summary
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sp-fs": "integer",
"area-id": "integer"
}
SPF-RUNTIME - Retrieve
Retrieve operation of resource: spf-runtime
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-delete-routes": "integer",
"start-time": "integer",
"global-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"lsa": [
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
],
"lsa-changes": "string",
"reason-flags": "string",
"area-stat": [
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
],
"rib-add-routes": "integer"
}
GLOBAL-TIME - Retrieve
Retrieve operation of resource: global-time
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
}
LSA - Retrieve
Retrieve operation of resource: lsa
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
AREA-STAT - Retrieve
Retrieve operation of resource: area-stat
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
SPF-STAT-TIME - Retrieve
Retrieve operation of resource: spf-stat-time
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
}
RAWIO-STATS - Retrieve
Retrieve operation of resource: rawio-stats
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out-error-drops": "integer",
"in-short-drops": "integer",
"out-bytes": "integer",
"in-bytes": "integer",
"in-queue-drops": "integer",
"out-nopak-drops": "integer",
"raw-conn-open": "integer",
"raw-conn-close": "integer",
"in-long-packets": "integer",
"in-handle-drops": "integer",
"in-error-drops": "integer",
"raw-conn-state": "integer",
"out-pakapi-errors": "integer",
"in-packets": "integer",
"in-malloc-drops": "integer",
"out-nofd-drops": "integer",
"raw-conn-error": "integer",
"in-ipsec-drops": "integer",
"out-ipsec-drops": "integer",
"out-packets": "integer"
}
PREFIX-PRIORITY-STATS - Retrieve
Retrieve operation of resource: prefix-priority-stats
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"high": "integer",
"medium": "integer",
"critical": "integer",
"low": "integer"
}
VRF-RIB-BATCH-STATS - Retrieve
Retrieve operation of resource: vrf-rib-batch-stats
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route": {
"total-sent-route": "integer",
"inter-area-route": "integer",
"nssa-two-route": "integer",
"extern-two-route": "integer",
"route-connected": "integer",
"redistribution-route": "integer",
"intra-area-route": "integer",
"nssa-one-route": "integer",
"extern-one-route": "integer",
"total-received-route": "integer",
"route-id": "string"
},
"protocol": {
"administrative-distance-inter-area": "integer",
"protocol-router-id": "string",
"is-graceful-restart": "boolean",
"administrative-distance": "integer",
"administrative-distance-external": "integer",
"distribute-list-in": "string"
},
"ospfv3": {
"is-nsr-enabled": "boolean",
"normal-areas": "integer",
"is-router-id-stalled": "boolean",
"last-nsf-time": "integer",
"lsa-hold-time": "integer",
"metric": "integer",
"is-grace-restart-enabled": "boolean",
"stub-areas": "integer",
"grace-resync-time": "integer",
"ipfrr-tiebreakers": [
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
],
"snmp-trap-enabled": "boolean",
"spf-start-time": "integer",
"default-metric": "integer",
"as-dc-bitless-ls-as": "integer",
"router-id": "string",
"spf-hold-time": "integer",
"context-name": "string",
"reference-bandwidth": "integer",
"as-lsa-flood-list-length": "integer",
"domain-id": {
"secondary-domain-id": [
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
],
"primary-domain-id": {
"domain-id-type": "integer",
"domain-id-value": "string"
}
},
"role": "integer",
"lsa-maximum-time": "integer",
"default-tag": "integer",
"is-default-originated": "boolean",
"is-opaque-capable": "boolean",
"opaque-lsas": "integer",
"is-nsr-switchover-on-restart": "boolean",
"is-area-border-router": "boolean",
"spf-maximum-time": "integer",
"maximum-paths": "integer",
"nssa-areas": "integer",
"lsa-retransmission-pacing-interval": "integer",
"default-metric-type": "string",
"minimum-lsa-interval": "integer",
"maximum-interfaces": "integer",
"redistribution-threshold": "integer",
"is-role-standby": "boolean",
"as-ls-as": "integer",
"lsa-group-interval": "integer",
"lsa-flood-pacing-interval": "integer",
"is-auto-cost": "boolean",
"redistribution-limit": "integer",
"areas": "integer",
"is-as-border-router": "boolean",
"opaque-lsa-checksum": "integer",
"stub-router": [
{
"remaining-time": "integer",
"include-stub-links": "boolean",
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"summary-lsa-metric": "integer",
"abr-off-reason": "string",
"external-lsa-metric": "integer"
}
]
}
}
PROTOCOL - Retrieve
Retrieve operation of resource: protocol
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"administrative-distance-inter-area": "integer",
"protocol-router-id": "string",
"is-graceful-restart": "boolean",
"administrative-distance": "integer",
"administrative-distance-external": "integer",
"distribute-list-in": "string"
}
OSPFV3 - Retrieve
Retrieve operation of resource: ospfv3
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-nsr-enabled": "boolean",
"normal-areas": "integer",
"is-router-id-stalled": "boolean",
"last-nsf-time": "integer",
"lsa-hold-time": "integer",
"metric": "integer",
"is-grace-restart-enabled": "boolean",
"stub-areas": "integer",
"grace-resync-time": "integer",
"ipfrr-tiebreakers": [
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
],
"snmp-trap-enabled": "boolean",
"spf-start-time": "integer",
"default-metric": "integer",
"as-dc-bitless-ls-as": "integer",
"router-id": "string",
"spf-hold-time": "integer",
"context-name": "string",
"reference-bandwidth": "integer",
"as-lsa-flood-list-length": "integer",
"domain-id": {
"secondary-domain-id": [
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
],
"primary-domain-id": {
"domain-id-type": "integer",
"domain-id-value": "string"
}
},
"role": "integer",
"lsa-maximum-time": "integer",
"default-tag": "integer",
"is-default-originated": "boolean",
"is-opaque-capable": "boolean",
"opaque-lsas": "integer",
"is-nsr-switchover-on-restart": "boolean",
"is-area-border-router": "boolean",
"spf-maximum-time": "integer",
"maximum-paths": "integer",
"nssa-areas": "integer",
"lsa-retransmission-pacing-interval": "integer",
"default-metric-type": "string",
"minimum-lsa-interval": "integer",
"maximum-interfaces": "integer",
"redistribution-threshold": "integer",
"is-role-standby": "boolean",
"as-ls-as": "integer",
"lsa-group-interval": "integer",
"lsa-flood-pacing-interval": "integer",
"is-auto-cost": "boolean",
"redistribution-limit": "integer",
"areas": "integer",
"is-as-border-router": "boolean",
"opaque-lsa-checksum": "integer",
"stub-router": [
{
"remaining-time": "integer",
"include-stub-links": "boolean",
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"summary-lsa-metric": "integer",
"abr-off-reason": "string",
"external-lsa-metric": "integer",
"trigger": [
{
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"trigger": "string",
"unset-reason": "string",
"time": "integer",
"wait-for-bgp": "boolean"
}
],
"abr-resume-time": {
"second": "integer",
"nanosecond": "integer"
},
"mode": "string",
"active": "boolean",
"unset-reason": "string",
"set-reason": "string"
}
]
}
DOMAIN-ID - Retrieve
Retrieve operation of resource: domain-id
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"secondary-domain-id": [
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
],
"primary-domain-id": {
"domain-id-type": "integer",
"domain-id-value": "string"
}
}
PRIMARY-DOMAIN-ID - Retrieve
Retrieve operation of resource: primary-domain-id
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
SECONDARY-DOMAIN-ID - Retrieve
Retrieve operation of resource: secondary-domain-id
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
STUB-ROUTER - Retrieve
Retrieve operation of resource: stub-router
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remaining-time": "integer",
"include-stub-links": "boolean",
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"summary-lsa-metric": "integer",
"abr-off-reason": "string",
"external-lsa-metric": "integer",
"trigger": [
{
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"trigger": "string",
"unset-reason": "string",
"time": "integer",
"wait-for-bgp": "boolean"
}
],
"abr-resume-time": {
"second": "integer",
"nanosecond": "integer"
},
"mode": "string",
"active": "boolean",
"unset-reason": "string",
"set-reason": "string"
}
UNSET-TIME - Retrieve
Retrieve operation of resource: unset-time
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
START-TIME - Retrieve
Retrieve operation of resource: start-time
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
ABR-RESUME-TIME - Retrieve
Retrieve operation of resource: abr-resume-time
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
TRIGGER - Retrieve
Retrieve operation of resource: trigger
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"trigger": "string",
"unset-reason": "string",
"time": "integer",
"wait-for-bgp": "boolean"
}
UNSET-TIME - Retrieve
Retrieve operation of resource: unset-time
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
START-TIME - Retrieve
Retrieve operation of resource: start-time
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
IPFRR-TIEBREAKERS - Retrieve
Retrieve operation of resource: ipfrr-tiebreakers
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
ROUTE - Retrieve
Retrieve operation of resource: route
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-sent-route": "integer",
"inter-area-route": "integer",
"nssa-two-route": "integer",
"extern-two-route": "integer",
"route-connected": "integer",
"redistribution-route": "integer",
"intra-area-route": "integer",
"nssa-one-route": "integer",
"extern-one-route": "integer",
"total-received-route": "integer",
"route-id": "string"
}
RETRANSMISSION-LIST-PROCESS-TABLE - Retrieve
Retrieve operation of resource: retransmission-list-process-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retransmission": [
{
"neighbor-address": "string",
"interface-name": "string",
"retransmission-area-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-asdb": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-timer": "integer",
"is-retransmissionvirtual-link": "boolean",
"retransmission-length": "integer",
"is-retransmission-sham-link": "boolean",
"retransmissionvirtual-link-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-neighbor-address": "string",
"retransmission-sham-link-id": "integer",
"retransmissionvirtual-link-id": "integer"
}
]
}
RETRANSMISSION - Retrieve
Retrieve operation of resource: retransmission
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retransmission-area-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-asdb": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-timer": "integer",
"is-retransmissionvirtual-link": "boolean",
"retransmission-length": "integer",
"is-retransmission-sham-link": "boolean",
"retransmissionvirtual-link-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-neighbor-address": "string",
"retransmission-sham-link-id": "integer",
"retransmissionvirtual-link-id": "integer"
}
RETRANSMISSIONVIRTUAL-LINK-DB - Retrieve
Retrieve operation of resource: retransmissionvirtual-link-db
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
RETRANSMISSION-AREA-DB - Retrieve
Retrieve operation of resource: retransmission-area-db
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
RETRANSMISSION-ASDB - Retrieve
Retrieve operation of resource: retransmission-asdb
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
BAD-CHECKSUMS - Retrieve
Retrieve operation of resource: bad-checksums
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bad-checksum": [
{
"timestamp": {
"second": "integer",
"nanosecond": "integer"
},
"computed-checksum": "integer",
"received-data": "string",
"received-checksum": "integer"
}
]
}
BAD-CHECKSUM - Retrieve
Retrieve operation of resource: bad-checksum
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
packet-number
in path
string
ID of packet-number
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"timestamp": {
"second": "integer",
"nanosecond": "integer"
},
"computed-checksum": "integer",
"received-data": "string",
"received-checksum": "integer"
}
TIMESTAMP - Retrieve
Retrieve operation of resource: timestamp
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
packet-number
in path
string
ID of packet-number
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
DATABASE-SUMMARY-TABLE - Retrieve
Retrieve operation of resource: database-summary-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database-summary": {
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
}
DATABASE-SUMMARY - Retrieve
Retrieve operation of resource: database-summary
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
DATABASE-COUNTERS - Retrieve
Retrieve operation of resource: database-counters
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
AREA-DATABASE - Retrieve
Retrieve operation of resource: area-database
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
AREA-DATABASE-SUMMARY - Retrieve
Retrieve operation of resource: area-database-summary
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
NEIGHBOR-PROCESS-TABLE - Retrieve
Retrieve operation of resource: neighbor-process-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: neighbor-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
}
NEIGHBOR-RETRANSMISSION - Retrieve
Retrieve operation of resource: neighbor-retransmission
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
NEIGHBOR-BFD-INFO - Retrieve
Retrieve operation of resource: neighbor-bfd-info
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
}
FAST-REROUTES - Retrieve
Retrieve operation of resource: fast-reroutes
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fast-reroute": [
{
"ipfrr-router-id": "string",
"ipfrr-area-revision": "integer",
"ipfrr-topo": [
{
"distance": "integer",
"neighbor-sourced": "boolean",
"lsaid": "integer",
"type4": "boolean",
"dr": "boolean",
"node-id": "string",
"revision": "integer"
}
],
"ipfrr-topo-area-id": "string"
}
]
}
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipfrr-router-id": "string",
"ipfrr-area-revision": "integer",
"ipfrr-topo": [
{
"distance": "integer",
"neighbor-sourced": "boolean",
"lsaid": "integer",
"type4": "boolean",
"dr": "boolean",
"node-id": "string",
"revision": "integer"
}
],
"ipfrr-topo-area-id": "string"
}
IPFRR-TOPO - Retrieve
Retrieve operation of resource: ipfrr-topo
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"distance": "integer",
"neighbor-sourced": "boolean",
"lsaid": "integer",
"type4": "boolean",
"dr": "boolean",
"node-id": "string",
"revision": "integer"
}
INTERFACE-BRIEF-PROCESS-TABLE - Retrieve
Retrieve operation of resource: interface-brief-process-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-brief": [
{
"interface-name": "string",
"interface-neighbors": "integer",
"interface-link-cost": "integer",
"interface-adjacent-neighbors": "integer",
"interface-address": "string",
"network-type": "string",
"ospf-interface-state": "string"
}
]
}
INTERFACE-BRIEF - Retrieve
Retrieve operation of resource: interface-brief
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbors": "integer",
"interface-link-cost": "integer",
"interface-adjacent-neighbors": "integer",
"interface-address": "string",
"network-type": "string",
"ospf-interface-state": "string"
}
NEIGHBOR-DETAIL-PROCESS-TABLE - Retrieve
Retrieve operation of resource: neighbor-detail-process-table
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-detail": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: neighbor-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: neighbor-detail
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
}
NEIGHBOR-RETRANSMISSION - Retrieve
Retrieve operation of resource: neighbor-retransmission
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
NEIGHBOR-BFD-INFO - Retrieve
Retrieve operation of resource: neighbor-bfd-info
process-name
in path
string
ID of process-name
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu-stats": {
"nsr-lsa-qad-mdata-count": "integer",
"nsr-nbr-init-sync-pend-count": "string",
"nsr-mtu": "integer",
"nsr-nbr-qad-mdata-count": "integer",
"nsr-conn-to-active-closes": "integer",
"nsr-conn-to-active-errors": "integer",
"nsr-nbr-seq-no": "integer",
"nsr-conn-to-active-opens": "integer",
"nsr-issu-milestone": [
{
"milestone-name": "string",
"milestone-status": "string"
}
],
"nsr-version": "integer",
"nsr-intf-seq-no": "integer",
"nsr-tmr-quant": "string",
"nsr-fsm-running-timer": [
"string"
],
"nsr-lsa-init-sync-pend-count": "string",
"nsr-peer-node-id": "integer",
"nsr-fsm-flag": [
"string"
],
"nsr-conn-to-active-attempts": "integer",
"nsr-conn-to-active-fails": "integer",
"nsr-peer-version": "integer",
"nsr-thd-stats": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-rtr-thd-sched": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-revision": "string",
"nsr-node-id": "integer",
"nsr-lsa-qad-qid": "integer",
"nsr-nbr-qad-qid": "integer",
"nsr-err-history": [
{
"nsr-error-info": [
{
"last-err-time": {}
}
]
}
]
},
"vrf-rib-batch-stats": {
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
}
NSR-STATS - Retrieve
Retrieve operation of resource: nsr-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-lsa-qad-mdata-count": "integer",
"nsr-nbr-init-sync-pend-count": "string",
"nsr-mtu": "integer",
"nsr-nbr-qad-mdata-count": "integer",
"nsr-conn-to-active-closes": "integer",
"nsr-conn-to-active-errors": "integer",
"nsr-nbr-seq-no": "integer",
"nsr-conn-to-active-opens": "integer",
"nsr-issu-milestone": [
{
"milestone-name": "string",
"milestone-status": "string"
}
],
"nsr-version": "integer",
"nsr-intf-seq-no": "integer",
"nsr-tmr-quant": "string",
"nsr-fsm-running-timer": [
"string"
],
"nsr-lsa-init-sync-pend-count": "string",
"nsr-peer-node-id": "integer",
"nsr-fsm-flag": [
"string"
],
"nsr-conn-to-active-attempts": "integer",
"nsr-conn-to-active-fails": "integer",
"nsr-peer-version": "integer",
"nsr-thd-stats": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-rtr-thd-sched": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-revision": "string",
"nsr-node-id": "integer",
"nsr-lsa-qad-qid": "integer",
"nsr-nbr-qad-qid": "integer",
"nsr-err-history": [
{
"nsr-error-info": [
{
"last-err-time": {
"second": "integer",
"nanosecond": "integer"
},
"err-info-string": "string",
"err-count": "string"
}
],
"nsr-revisionversion": "integer",
"total-errors": "string"
}
],
"nsr-fsm-state": "string"
}
NSR-THD-STATS - Retrieve
Retrieve operation of resource: nsr-thd-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
}
NSR-PRI - Retrieve
Retrieve operation of resource: nsr-pri
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
NSR-RTR-THD-SCHED - Retrieve
Retrieve operation of resource: nsr-rtr-thd-sched
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
}
NSR-PRI - Retrieve
Retrieve operation of resource: nsr-pri
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
NSR-ISSU-MILESTONE - Retrieve
Retrieve operation of resource: nsr-issu-milestone
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"milestone-name": "string",
"milestone-status": "string"
}
NSR-ERR-HISTORY - Retrieve
Retrieve operation of resource: nsr-err-history
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-error-info": [
{
"last-err-time": {
"second": "integer",
"nanosecond": "integer"
},
"err-info-string": "string",
"err-count": "string"
}
],
"nsr-revisionversion": "integer",
"total-errors": "string"
}
NSR-ERROR-INFO - Retrieve
Retrieve operation of resource: nsr-error-info
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-err-time": {
"second": "integer",
"nanosecond": "integer"
},
"err-info-string": "string",
"err-count": "string"
}
LAST-ERR-TIME - Retrieve
Retrieve operation of resource: last-err-time
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
RIB-THREAD-STATS - Retrieve
Retrieve operation of resource: rib-thread-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-batch-limit": "integer",
"rib-batch-purged": "integer",
"rib-route-some-err": "integer",
"rib-batch-ok": "integer",
"holdq": [
{
"wq-len-max": "string",
"wq-total-dequeued": "integer",
"wq-sum-latency": "integer",
"wq-first-eqtime": "integer",
"wq-dequeue-errs": "integer",
"wq-total-enqueued": "integer",
"wq-len-cur": "string",
"wq-dqtime": "integer",
"wq-eqtime": "integer",
"wq-max-latency": "integer",
"wq-eneueue-errs": "integer"
}
],
"rib-batch-some-err": "integer",
"rib-path-limit": "integer",
"thread-q": {
"wq-len-max": "string",
"wq-total-dequeued": "integer",
"wq-sum-latency": "integer",
"wq-first-eqtime": "integer",
"wq-dequeue-errs": "integer",
"wq-total-enqueued": "integer",
"wq-len-cur": "string",
"wq-dqtime": "integer",
"wq-eqtime": "integer",
"wq-max-latency": "integer",
"wq-eneueue-errs": "integer"
},
"rib-batch-backup": "integer",
"rib-route-err": "integer",
"rib-drop-version": "integer",
"wq-signals": "integer",
"wq-thread-active": "boolean",
"rib-base-time": {
"second": "integer",
"nanosecond": "integer"
},
"rib-drop-conn": "integer",
"rib-batch-sent": "integer",
"rib-batch-no-table": "integer",
"rib-route-limit": "integer",
"rib-sum-latency": "integer",
"rib-base-clock": "integer",
"rib-path-err": "integer",
"rib-max-latency": "integer",
"rib-batch-err": "integer"
}
THREAD-Q - Retrieve
Retrieve operation of resource: thread-q
process-name
in path
string
ID of process-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wq-len-max": "string",
"wq-total-dequeued": "integer",
"wq-sum-latency": "integer",
"wq-first-eqtime": "integer",
"wq-dequeue-errs": "integer",
"wq-total-enqueued": "integer",
"wq-len-cur": "string",
"wq-dqtime": "integer",
"wq-eqtime": "integer",
"wq-max-latency": "integer",
"wq-eneueue-errs": "integer"
}
RIB-BASE-TIME - Retrieve
Retrieve operation of resource: rib-base-time
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
HOLDQ - Retrieve
Retrieve operation of resource: holdq
process-name
in path
string
ID of process-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wq-len-max": "string",
"wq-total-dequeued": "integer",
"wq-sum-latency": "integer",
"wq-first-eqtime": "integer",
"wq-dequeue-errs": "integer",
"wq-total-enqueued": "integer",
"wq-len-cur": "string",
"wq-dqtime": "integer",
"wq-eqtime": "integer",
"wq-max-latency": "integer",
"wq-eneueue-errs": "integer"
}
ISSU-STATS - Retrieve
Retrieve operation of resource: issu-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-lsa-qad-mdata-count": "integer",
"nsr-nbr-init-sync-pend-count": "string",
"nsr-mtu": "integer",
"nsr-nbr-qad-mdata-count": "integer",
"nsr-conn-to-active-closes": "integer",
"nsr-conn-to-active-errors": "integer",
"nsr-nbr-seq-no": "integer",
"nsr-conn-to-active-opens": "integer",
"nsr-issu-milestone": [
{
"milestone-name": "string",
"milestone-status": "string"
}
],
"nsr-version": "integer",
"nsr-intf-seq-no": "integer",
"nsr-tmr-quant": "string",
"nsr-fsm-running-timer": [
"string"
],
"nsr-lsa-init-sync-pend-count": "string",
"nsr-peer-node-id": "integer",
"nsr-fsm-flag": [
"string"
],
"nsr-conn-to-active-attempts": "integer",
"nsr-conn-to-active-fails": "integer",
"nsr-peer-version": "integer",
"nsr-thd-stats": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-rtr-thd-sched": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-revision": "string",
"nsr-node-id": "integer",
"nsr-lsa-qad-qid": "integer",
"nsr-nbr-qad-qid": "integer",
"nsr-err-history": [
{
"nsr-error-info": [
{
"last-err-time": {
"second": "integer",
"nanosecond": "integer"
},
"err-info-string": "string",
"err-count": "string"
}
],
"nsr-revisionversion": "integer",
"total-errors": "string"
}
],
"nsr-fsm-state": "string"
}
NSR-THD-STATS - Retrieve
Retrieve operation of resource: nsr-thd-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
}
NSR-PRI - Retrieve
Retrieve operation of resource: nsr-pri
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
NSR-RTR-THD-SCHED - Retrieve
Retrieve operation of resource: nsr-rtr-thd-sched
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
}
NSR-PRI - Retrieve
Retrieve operation of resource: nsr-pri
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
NSR-ISSU-MILESTONE - Retrieve
Retrieve operation of resource: nsr-issu-milestone
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"milestone-name": "string",
"milestone-status": "string"
}
NSR-ERR-HISTORY - Retrieve
Retrieve operation of resource: nsr-err-history
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-error-info": [
{
"last-err-time": {
"second": "integer",
"nanosecond": "integer"
},
"err-info-string": "string",
"err-count": "string"
}
],
"nsr-revisionversion": "integer",
"total-errors": "string"
}
NSR-ERROR-INFO - Retrieve
Retrieve operation of resource: nsr-error-info
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-err-time": {
"second": "integer",
"nanosecond": "integer"
},
"err-info-string": "string",
"err-count": "string"
}
LAST-ERR-TIME - Retrieve
Retrieve operation of resource: last-err-time
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
NSR-PL-STATS - Retrieve
Retrieve operation of resource: nsr-pl-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ncd-pri": [
{
"num-recv-drop": [
{
"nsr-pl-recv-drop-array": [
"integer"
]
}
],
"num-recv": [
"integer"
],
"num-sent": [
"integer"
],
"num-sent-drop": [
{
"nsr-pl-send-drop-array": [
"integer"
]
}
]
}
]
}
NCD-PRI - Retrieve
Retrieve operation of resource: ncd-pri
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-recv-drop": [
{
"nsr-pl-recv-drop-array": [
"integer"
]
}
],
"num-recv": [
"integer"
],
"num-sent": [
"integer"
],
"num-sent-drop": [
{
"nsr-pl-send-drop-array": [
"integer"
]
}
]
}
NUM-SENT-DROP - Retrieve
Retrieve operation of resource: num-sent-drop
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-pl-send-drop-array": [
"integer"
]
}
NUM-RECV-DROP - Retrieve
Retrieve operation of resource: num-recv-drop
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-pl-recv-drop-array": [
"integer"
]
}
PROTOCOL-STATS - Retrieve
Retrieve operation of resource: protocol-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-stat": [
{
"ls-req-in-packets": "integer",
"ls-upd-in-ignored": "integer",
"total-out-packets": "integer",
"ls-req-in-ls-as": "integer",
"ls-ack-out-packets": "integer",
"ls-req-out-packets": "integer",
"total-in-packets": "integer",
"ls-ack-in-ls-as": "integer",
"dropped-in-gs": "integer",
"dbdes-in-ls-as": "integer",
"ls-upd-out-ls-as": "integer",
"hello-out-packets": "integer",
"dbdes-out-ls-as": "integer",
"ls-upd-in-packets": "integer",
"checksum-err": "integer",
"ls-upd-out-packets": "integer",
"ls-req-out-ls-as": "integer",
"ls-upd-in-ls-as": "integer",
"dbdes-out-packets": "integer",
"ls-ack-in-packets": "integer",
"ls-ack-out-ls-as": "integer",
"hello-in-packets": "integer",
"dbdes-in-packets": "integer"
}
]
}
PROTOCOL-STAT - Retrieve
Retrieve operation of resource: protocol-stat
process-name
in path
string
ID of process-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ls-req-in-packets": "integer",
"ls-upd-in-ignored": "integer",
"total-out-packets": "integer",
"ls-req-in-ls-as": "integer",
"ls-ack-out-packets": "integer",
"ls-req-out-packets": "integer",
"total-in-packets": "integer",
"ls-ack-in-ls-as": "integer",
"dropped-in-gs": "integer",
"dbdes-in-ls-as": "integer",
"ls-upd-out-ls-as": "integer",
"hello-out-packets": "integer",
"dbdes-out-ls-as": "integer",
"ls-upd-in-packets": "integer",
"checksum-err": "integer",
"ls-upd-out-packets": "integer",
"ls-req-out-ls-as": "integer",
"ls-upd-in-ls-as": "integer",
"dbdes-out-packets": "integer",
"ls-ack-in-packets": "integer",
"ls-ack-out-ls-as": "integer",
"hello-in-packets": "integer",
"dbdes-in-packets": "integer"
}
SPF-STATS - Retrieve
Retrieve operation of resource: spf-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spf-runtime": [
{
"rib-delete-routes": "integer",
"start-time": "integer",
"global-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"lsa": [
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
],
"lsa-changes": "string",
"reason-flags": "string",
"area-stat": [
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
],
"rib-add-routes": "integer"
}
],
"spf-header": {
"area-summary": [
{
"sp-fs": "integer",
"area-id": "integer"
}
],
"header-sp-fs": "integer",
"header-router-id": "string"
}
}
SPF-HEADER - Retrieve
Retrieve operation of resource: spf-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-summary": [
{
"sp-fs": "integer",
"area-id": "integer"
}
],
"header-sp-fs": "integer",
"header-router-id": "string"
}
AREA-SUMMARY - Retrieve
Retrieve operation of resource: area-summary
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sp-fs": "integer",
"area-id": "integer"
}
SPF-RUNTIME - Retrieve
Retrieve operation of resource: spf-runtime
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-delete-routes": "integer",
"start-time": "integer",
"global-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"lsa": [
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
],
"lsa-changes": "string",
"reason-flags": "string",
"area-stat": [
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
],
"rib-add-routes": "integer"
}
GLOBAL-TIME - Retrieve
Retrieve operation of resource: global-time
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
}
LSA - Retrieve
Retrieve operation of resource: lsa
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
AREA-STAT - Retrieve
Retrieve operation of resource: area-stat
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
SPF-STAT-TIME - Retrieve
Retrieve operation of resource: spf-stat-time
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
}
RAWIO-STATS - Retrieve
Retrieve operation of resource: rawio-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out-error-drops": "integer",
"in-short-drops": "integer",
"out-bytes": "integer",
"in-bytes": "integer",
"in-queue-drops": "integer",
"out-nopak-drops": "integer",
"raw-conn-open": "integer",
"raw-conn-close": "integer",
"in-long-packets": "integer",
"in-handle-drops": "integer",
"in-error-drops": "integer",
"raw-conn-state": "integer",
"out-pakapi-errors": "integer",
"in-packets": "integer",
"in-malloc-drops": "integer",
"out-nofd-drops": "integer",
"raw-conn-error": "integer",
"in-ipsec-drops": "integer",
"out-ipsec-drops": "integer",
"out-packets": "integer"
}
PREFIX-PRIORITY-STATS - Retrieve
Retrieve operation of resource: prefix-priority-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"high": "integer",
"medium": "integer",
"critical": "integer",
"low": "integer"
}
VRF-RIB-BATCH-STATS - Retrieve
Retrieve operation of resource: vrf-rib-batch-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
DEFAULT-VRF - Retrieve
Retrieve operation of resource: default-vrf
process-name
in path
string
ID of process-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-detail-process-table": {
"neighbor-detail": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
}
SUMMARY-PREFIXES - Retrieve
Retrieve operation of resource: summary-prefixes
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary-prefix": [
{
"prefix-metric": "integer",
"prefix-metric-type": "string",
"tag": "integer"
}
]
}
SUMMARY-PREFIX - Retrieve
Retrieve operation of resource: summary-prefix
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-metric": "integer",
"prefix-metric-type": "string",
"tag": "integer"
}
BORDER-ROUTERS - Retrieve
Retrieve operation of resource: border-routers
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"border-router": [
{
"border-router-path": [
{
"interface-name": "string",
"border-router-area-id": "string",
"border-router-type": "string",
"border-router-next-hop": "string",
"border-router-route-metric": "integer",
"spf-version": "integer",
"is-intra-area-router": "boolean"
}
]
}
]
}
BORDER-ROUTER - Retrieve
Retrieve operation of resource: border-router
process-name
in path
string
ID of process-name
border-router-id
in path
string
ID of border-router-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"border-router-path": [
{
"interface-name": "string",
"border-router-area-id": "string",
"border-router-type": "string",
"border-router-next-hop": "string",
"border-router-route-metric": "integer",
"spf-version": "integer",
"is-intra-area-router": "boolean"
}
]
}
BORDER-ROUTER-PATH - Retrieve
Retrieve operation of resource: border-router-path
process-name
in path
string
ID of process-name
border-router-id
in path
string
ID of border-router-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"border-router-area-id": "string",
"border-router-type": "string",
"border-router-next-hop": "string",
"border-router-route-metric": "integer",
"spf-version": "integer",
"is-intra-area-router": "boolean"
}
SHAM-LINK-TABLE - Retrieve
Retrieve operation of resource: sham-link-table
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"virtual-link-authentication-spi": "integer",
"is-sham-link-ip-security-active": "boolean",
"sham-link-last-gr": "integer",
"sham-link-retransmission-interval": "integer",
"sham-link-area": "string",
"is-sham-link-ip-security-required": "boolean",
"sham-link-demand-circuit": "boolean",
"sham-link-ifindex": "integer",
"sham-link-encryption-transmitted": "integer",
"sham-link-authentication-transmit": "integer",
"sham-link-neighbor": {
"sham-link-state": "string",
"sham-link-suppress-hello": "boolean",
"sham-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
},
"sham-link-dest-address": "string",
"sham-link-dc-bitless-lsa": "integer",
"sham-link-encryption-spi": "integer",
"sham-link-dead-interval": "integer",
"sham-link-wait-interval": "integer",
"is-sham-link-authentication-enabled": "boolean",
"sham-link-neighbor-id": "string",
"sham-link-next-hello": "integer",
"sham-link-gr-enabled": "boolean",
"sham-link-transmission-delay": "integer",
"sham-link-cost": "integer",
"sham-link-gr": "boolean",
"sham-link-passive": "boolean",
"sham-link-encrypted-authentication-transmitted": "integer",
"is-sham-link-encryption-enabled": "boolean",
"sham-link-hello-interval": "integer",
"sham-link-state": "string",
"sham-link-source-address": "string"
}
SHAM-LINK-NEIGHBOR - Retrieve
Retrieve operation of resource: sham-link-neighbor
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sham-link-state": "string",
"sham-link-suppress-hello": "boolean",
"sham-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
}
SHAM-LINK-RETRANSMISSION - Retrieve
Retrieve operation of resource: sham-link-retransmission
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
AREA-INFORMATIONS - Retrieve
Retrieve operation of resource: area-informations
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-information": [
{
"is-area-stubbed": "boolean",
"is-rrr-enabled": "boolean",
"area-lfa-revision": "integer",
"is-nssa-translated": "boolean",
"indication-ls-as": "integer",
"is-area-nssa": "boolean",
"is-backbone-area-active": "boolean",
"area-lfa-interface-count": "integer",
"area-interfaces": "integer",
"is-area-total-stubbed": "boolean",
"area-opaque-lsas": "integer",
"is-nssa-translated-always": "boolean",
"flood-list-length": "integer",
"stub-default-cost": "integer",
"is-nssa-default": "boolean",
"sp-fs": "integer",
"area-per-prefix-lfa-interface-count": "integer",
"area-opaque-lsa-checksum": "integer",
"nssa-no-redistribution": "boolean",
"area-range": [
{
"range-prefix": "string",
"net-cost": "integer",
"range-prefix-length": "integer",
"status": "string",
"is-cost-configured": "boolean"
}
],
"area-dc-bitless-ls-as": "integer",
"do-not-age-ls-as": "integer"
}
]
}
AREA-INFORMATION - Retrieve
Retrieve operation of resource: area-information
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-area-stubbed": "boolean",
"is-rrr-enabled": "boolean",
"area-lfa-revision": "integer",
"is-nssa-translated": "boolean",
"indication-ls-as": "integer",
"is-area-nssa": "boolean",
"is-backbone-area-active": "boolean",
"area-lfa-interface-count": "integer",
"area-interfaces": "integer",
"is-area-total-stubbed": "boolean",
"area-opaque-lsas": "integer",
"is-nssa-translated-always": "boolean",
"flood-list-length": "integer",
"stub-default-cost": "integer",
"is-nssa-default": "boolean",
"sp-fs": "integer",
"area-per-prefix-lfa-interface-count": "integer",
"area-opaque-lsa-checksum": "integer",
"nssa-no-redistribution": "boolean",
"area-range": [
{
"range-prefix": "string",
"net-cost": "integer",
"range-prefix-length": "integer",
"status": "string",
"is-cost-configured": "boolean"
}
],
"area-dc-bitless-ls-as": "integer",
"do-not-age-ls-as": "integer"
}
AREA-RANGE - Retrieve
Retrieve operation of resource: area-range
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range-prefix": "string",
"net-cost": "integer",
"range-prefix-length": "integer",
"status": "string",
"is-cost-configured": "boolean"
}
DATABASE-TABLE - Retrieve
Retrieve operation of resource: database-table
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-table": {
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer"
}
}
}
}
]
}
}
LSA-TABLE - Retrieve
Retrieve operation of resource: lsa-table
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean"
}
}
}
}
]
}
LSA - Retrieve
Retrieve operation of resource: lsa
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
}
}
LSA-INFO - Retrieve
Retrieve operation of resource: lsa-info
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean"
}
}
LSA-SUMMARY-INFO - Retrieve
Retrieve operation of resource: lsa-summary-info
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-router-id": "integer",
"prefix-length": "integer",
"interface-name": "string",
"links": "integer",
"is-virtual-link": "boolean",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"reference-lsa-id": "integer",
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": "string",
"reference-type": "integer",
"router-la-bits": "integer",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: router-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link": [
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
],
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"router-la-bits": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"rpf-path": {
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
LINK - Retrieve
Retrieve operation of resource: link
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
NETWORK-LSA-TYPE - Retrieve
Retrieve operation of resource: network-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"neighbor-router": [
"string"
],
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-prefix-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"prefix": "string",
"prefix-length": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-router-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"lsa-router-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
EXTERNAL-LSA-TYPE - Retrieve
Retrieve operation of resource: external-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
NSSALSA-TYPE - Retrieve
Retrieve operation of resource: nssalsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: link-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"router-priority": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"lsa-link-local": "string",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
INTRA-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: intra-area-prefix-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reference-lsa-id": "integer",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"reference-advertised-router": "string",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"reference-type": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
GRACE-LSA - Retrieve
Retrieve operation of resource: grace-lsa
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer",
"grace-reason": "string"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-link-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-AREA-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-area-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-ASLSA-TYPE - Retrieve
Retrieve operation of resource: unknown-aslsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
LSA-INTERNAL-TABLE - Retrieve
Retrieve operation of resource: lsa-internal-table
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean"
}
}
}
}
]
}
LSA - Retrieve
Retrieve operation of resource: lsa
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
}
}
LSA-INFO - Retrieve
Retrieve operation of resource: lsa-info
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean"
}
}
LSA-SUMMARY-INFO - Retrieve
Retrieve operation of resource: lsa-summary-info
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-router-id": "integer",
"prefix-length": "integer",
"interface-name": "string",
"links": "integer",
"is-virtual-link": "boolean",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"reference-lsa-id": "integer",
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": "string",
"reference-type": "integer",
"router-la-bits": "integer",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: router-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link": [
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
],
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"router-la-bits": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"rpf-path": {
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
LINK - Retrieve
Retrieve operation of resource: link
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
NETWORK-LSA-TYPE - Retrieve
Retrieve operation of resource: network-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"neighbor-router": [
"string"
],
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-prefix-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"prefix": "string",
"prefix-length": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-router-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"lsa-router-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
EXTERNAL-LSA-TYPE - Retrieve
Retrieve operation of resource: external-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
NSSALSA-TYPE - Retrieve
Retrieve operation of resource: nssalsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: link-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"router-priority": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"lsa-link-local": "string",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
INTRA-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: intra-area-prefix-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reference-lsa-id": "integer",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"reference-advertised-router": "string",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"reference-type": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
GRACE-LSA - Retrieve
Retrieve operation of resource: grace-lsa
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer",
"grace-reason": "string"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-link-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-AREA-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-area-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-ASLSA-TYPE - Retrieve
Retrieve operation of resource: unknown-aslsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-lsa-type
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTERFACE-PROCESS-TABLE - Retrieve
Retrieve operation of resource: interface-process-table
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"dead-interval": "integer",
"interface-bfd": {
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
},
"interface-encrypted-authentication-transmitted": "integer",
"network-type": "string",
"is-interface-encryption-enabled": "boolean",
"interface-references": "integer",
"backup-designated-router-address": "string",
"is-interface-ip-security-active": "boolean",
"interface-link-cost": "integer",
"interface-address": "string",
"adjacent-neighbor": "integer",
"configured-ldp-sync": "boolean",
"interface-number": "integer",
"designated-router-address": "string",
"transmission-delay": "integer",
"interface-router-id": "string",
"interface-ldp-sync": "boolean",
"interface-dc-bitless-ls-as": "integer",
"ospf-interface-state": "string",
"designated-router-id": "string",
"is-prefix-suppress": "boolean",
"is-interface-lsa-filtered": "boolean",
"hello-interval": "integer",
"next-hello-time": "integer",
"interface-neighbor": [
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
],
"network-lsa-flush-timer": "integer",
"is-interface-demand-circuit": "boolean",
"interface-encryption-transmitted": "integer",
"interface-state": "string",
"wait-interval": "integer",
"is-designated-router": "boolean",
"active-interface": {
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
},
"backup-designated-router-id": "string",
"is-interface-flood-reduction": "boolean",
"is-demand-circuit-configured": "boolean",
"interface-retransmission-interval": "integer",
"interface-authentication-spi": "integer",
"interface-encryption-spi": "integer",
"interface-authentication-transmit": "integer",
"interface-priority": "integer",
"is-interface-line-up": "boolean",
"is-interface-ip-security-required": "boolean"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
process-name
in path
string
ID of process-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dead-interval": "integer",
"interface-bfd": {
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
},
"interface-encrypted-authentication-transmitted": "integer",
"network-type": "string",
"is-interface-encryption-enabled": "boolean",
"interface-references": "integer",
"backup-designated-router-address": "string",
"is-interface-ip-security-active": "boolean",
"interface-link-cost": "integer",
"interface-address": "string",
"adjacent-neighbor": "integer",
"configured-ldp-sync": "boolean",
"interface-number": "integer",
"designated-router-address": "string",
"transmission-delay": "integer",
"interface-router-id": "string",
"interface-ldp-sync": "boolean",
"interface-dc-bitless-ls-as": "integer",
"ospf-interface-state": "string",
"designated-router-id": "string",
"is-prefix-suppress": "boolean",
"is-interface-lsa-filtered": "boolean",
"hello-interval": "integer",
"next-hello-time": "integer",
"interface-neighbor": [
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
],
"network-lsa-flush-timer": "integer",
"is-interface-demand-circuit": "boolean",
"interface-encryption-transmitted": "integer",
"interface-state": "string",
"wait-interval": "integer",
"is-designated-router": "boolean",
"active-interface": {
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
},
"backup-designated-router-id": "string",
"is-interface-flood-reduction": "boolean",
"is-demand-circuit-configured": "boolean",
"interface-retransmission-interval": "integer",
"interface-authentication-spi": "integer",
"interface-encryption-spi": "integer",
"interface-authentication-transmit": "integer",
"interface-priority": "integer",
"is-interface-line-up": "boolean",
"is-interface-ip-security-required": "boolean"
}
ACTIVE-INTERFACE - Retrieve
Retrieve operation of resource: active-interface
process-name
in path
string
ID of process-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
}
INTERFACE-BFD - Retrieve
Retrieve operation of resource: interface-bfd
process-name
in path
string
ID of process-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
}
INTERFACE-NEIGHBOR - Retrieve
Retrieve operation of resource: interface-neighbor
process-name
in path
string
ID of process-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
REDISTRIBUTIONS - Retrieve
Retrieve operation of resource: redistributions
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"redistribution": [
{
"red-metric": "integer",
"policy-name": "string",
"red-tag": "integer",
"red-metric-type": "integer",
"red-metric-flag": "boolean",
"red-mtype-flag": "boolean",
"process-id": "string",
"protocol-name-xr": "string"
}
]
}
REDISTRIBUTION - Retrieve
Retrieve operation of resource: redistribution
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"red-metric": "integer",
"policy-name": "string",
"red-tag": "integer",
"red-metric-type": "integer",
"red-metric-flag": "boolean",
"red-mtype-flag": "boolean",
"process-id": "string",
"protocol-name-xr": "string"
}
EXTERNAL-ROUTES - Retrieve
Retrieve operation of resource: external-routes
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"external-route": [
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-extended-community": {
"extended-community-domain-id-value": "string",
"extended-community-area-id": "integer",
"extended-community-router-id": "string",
"extended-community-route-type": "integer",
"extended-community-options": "integer",
"extended-communityl-domain-id-type": "integer"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
]
}
EXTERNAL-ROUTE - Retrieve
Retrieve operation of resource: external-route
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-extended-community": {
"extended-community-domain-id-value": "string",
"extended-community-area-id": "integer",
"extended-community-router-id": "string",
"extended-community-route-type": "integer",
"extended-community-options": "integer",
"extended-communityl-domain-id-type": "integer"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
ROUTE-TOPOLOGY - Retrieve
Retrieve operation of resource: route-topology
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
}
ROUTE-EXTENDED-COMMUNITY - Retrieve
Retrieve operation of resource: route-extended-community
process-name
in path
string
ID of process-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-community-domain-id-value": "string",
"extended-community-area-id": "integer",
"extended-community-router-id": "string",
"extended-community-route-type": "integer",
"extended-community-options": "integer",
"extended-communityl-domain-id-type": "integer"
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
ROUTE-BACKUP-PATH - Retrieve
Retrieve operation of resource: route-backup-path
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
}
NEIGHBOR-NEXT-HOP - Retrieve
Retrieve operation of resource: neighbor-next-hop
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-next-hop-intf-index": "integer"
}
REQUEST-LIST-PROCESS-TABLE - Retrieve
Retrieve operation of resource: request-list-process-table
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request": [
{
"neighbor-address": "string",
"interface-name": "string",
"request-virtual-link-id": "integer",
"request": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"request-neighbor-address": "string",
"request-sham-link-id": "integer",
"is-request-sham-link": "boolean",
"is-request-virtual-link": "boolean"
}
]
}
REQUEST - Retrieve
Retrieve operation of resource: request
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-virtual-link-id": "integer",
"request": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"request-neighbor-address": "string",
"request-sham-link-id": "integer",
"is-request-sham-link": "boolean",
"is-request-virtual-link": "boolean"
}
REQUEST - Retrieve
Retrieve operation of resource: request
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
VIRTUAL-LINK - Retrieve
Retrieve operation of resource: virtual-link
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-virtual-link-ip-security-required": "boolean",
"virtual-link-dc-bitless-lsa": "integer",
"virtual-link-cost": "integer",
"virtual-link-neighbor-id": "string",
"virtual-link-encrypted-authentication-transmitted": "integer",
"virtual-link-next-hello": "integer",
"virtual-link-dead-interval": "integer",
"is-virtual-link-demand-circuit": "boolean",
"virtual-link-hello-interval": "integer",
"virtual-link-state": "string",
"virtual-link-encryption-spi": "integer",
"virtual-link-wait-interval": "integer",
"virtual-link-neighbor": {
"virtual-link-state": "string",
"is-virtual-link-hello-suppressed": "boolean",
"virtual-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
},
"virtual-link-authentication-spi": "integer",
"virtual-link-retransmission-interval": "integer",
"virtual-link-encryption-transmitted": "integer",
"is-virtual-link-encryption-enabled": "boolean",
"virtual-link-neighbor-address": "string",
"transit-area-id": "string",
"is-virtual-link-authentication-enabled": "boolean",
"interface-name": "string",
"virual-link-transmission-delay": "integer",
"virtual-link-authentication-transmit": "integer",
"is-virtual-link-ip-security-active": "boolean",
"is-virtual-link-passive": "boolean",
"virtual-link-interface-number": "integer"
}
VIRTUAL-LINK-NEIGHBOR - Retrieve
Retrieve operation of resource: virtual-link-neighbor
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"virtual-link-state": "string",
"is-virtual-link-hello-suppressed": "boolean",
"virtual-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
}
VIRTUAL-LINK-RETRANSMISSION - Retrieve
Retrieve operation of resource: virtual-link-retransmission
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
FLOOD-LIST-PROCESS-TABLE - Retrieve
Retrieve operation of resource: flood-list-process-table
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flood": [
{
"interface-name": "string",
"queue-length": "integer",
"as-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"area-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"ls-transmission-timer": "integer",
"link-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
]
}
]
}
FLOOD - Retrieve
Retrieve operation of resource: flood
process-name
in path
string
ID of process-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"queue-length": "integer",
"as-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"area-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"ls-transmission-timer": "integer",
"link-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
]
}
LINK-FLOOD - Retrieve
Retrieve operation of resource: link-flood
process-name
in path
string
ID of process-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
AREA-FLOOD - Retrieve
Retrieve operation of resource: area-flood
process-name
in path
string
ID of process-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
AS-FLOOD - Retrieve
Retrieve operation of resource: as-flood
process-name
in path
string
ID of process-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
ROUTE-SUMMARY - Retrieve
Retrieve operation of resource: route-summary
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-sent-route": "integer",
"inter-area-route": "integer",
"nssa-two-route": "integer",
"extern-two-route": "integer",
"route-connected": "integer",
"redistribution-route": "integer",
"intra-area-route": "integer",
"nssa-one-route": "integer",
"extern-one-route": "integer",
"total-received-route": "integer",
"route-id": "string"
}
AREAS - Retrieve
Retrieve operation of resource: areas
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area": [
{
"database-summary-table": {
"database-summary": {
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
}
}
]
}
AREA - Retrieve
Retrieve operation of resource: area
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database-summary-table": {
"database-summary": {
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
}
}
NEIGHBOR-DETAIL-TABLE - Retrieve
Retrieve operation of resource: neighbor-detail-table
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-detail": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: neighbor-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: neighbor-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
}
NEIGHBOR-RETRANSMISSION - Retrieve
Retrieve operation of resource: neighbor-retransmission
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
NEIGHBOR-BFD-INFO - Retrieve
Retrieve operation of resource: neighbor-bfd-info
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
}
INTERFACE-BRIEF-TABLE - Retrieve
Retrieve operation of resource: interface-brief-table
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-brief": [
{
"interface-name": "string",
"interface-neighbors": "integer",
"interface-link-cost": "integer",
"interface-adjacent-neighbors": "integer",
"interface-address": "string",
"network-type": "string",
"ospf-interface-state": "string"
}
]
}
INTERFACE-BRIEF - Retrieve
Retrieve operation of resource: interface-brief
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbors": "integer",
"interface-link-cost": "integer",
"interface-adjacent-neighbors": "integer",
"interface-address": "string",
"network-type": "string",
"ospf-interface-state": "string"
}
REQUEST-LIST-TABLE - Retrieve
Retrieve operation of resource: request-list-table
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request": [
{
"neighbor-address": "string",
"interface-name": "string",
"request-virtual-link-id": "integer",
"request": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"request-neighbor-address": "string",
"request-sham-link-id": "integer",
"is-request-sham-link": "boolean",
"is-request-virtual-link": "boolean"
}
]
}
REQUEST - Retrieve
Retrieve operation of resource: request
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-virtual-link-id": "integer",
"request": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"request-neighbor-address": "string",
"request-sham-link-id": "integer",
"is-request-sham-link": "boolean",
"is-request-virtual-link": "boolean"
}
REQUEST - Retrieve
Retrieve operation of resource: request
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
NEIGHBOR-TABLE - Retrieve
Retrieve operation of resource: neighbor-table
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: neighbor-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
}
NEIGHBOR-RETRANSMISSION - Retrieve
Retrieve operation of resource: neighbor-retransmission
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
NEIGHBOR-BFD-INFO - Retrieve
Retrieve operation of resource: neighbor-bfd-info
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"dead-interval": "integer",
"interface-bfd": {
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
},
"interface-encrypted-authentication-transmitted": "integer",
"network-type": "string",
"is-interface-encryption-enabled": "boolean",
"interface-references": "integer",
"backup-designated-router-address": "string",
"is-interface-ip-security-active": "boolean",
"interface-link-cost": "integer",
"interface-address": "string",
"adjacent-neighbor": "integer",
"configured-ldp-sync": "boolean",
"interface-number": "integer",
"designated-router-address": "string",
"transmission-delay": "integer",
"interface-router-id": "string",
"interface-ldp-sync": "boolean",
"interface-dc-bitless-ls-as": "integer",
"ospf-interface-state": "string",
"designated-router-id": "string",
"is-prefix-suppress": "boolean",
"is-interface-lsa-filtered": "boolean",
"hello-interval": "integer",
"next-hello-time": "integer",
"interface-neighbor": [
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
],
"network-lsa-flush-timer": "integer",
"is-interface-demand-circuit": "boolean",
"interface-encryption-transmitted": "integer",
"interface-state": "string",
"wait-interval": "integer",
"is-designated-router": "boolean",
"active-interface": {
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
},
"backup-designated-router-id": "string",
"is-interface-flood-reduction": "boolean",
"is-demand-circuit-configured": "boolean",
"interface-retransmission-interval": "integer",
"interface-authentication-spi": "integer",
"interface-encryption-spi": "integer",
"interface-authentication-transmit": "integer",
"interface-priority": "integer",
"is-interface-line-up": "boolean",
"is-interface-ip-security-required": "boolean"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dead-interval": "integer",
"interface-bfd": {
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
},
"interface-encrypted-authentication-transmitted": "integer",
"network-type": "string",
"is-interface-encryption-enabled": "boolean",
"interface-references": "integer",
"backup-designated-router-address": "string",
"is-interface-ip-security-active": "boolean",
"interface-link-cost": "integer",
"interface-address": "string",
"adjacent-neighbor": "integer",
"configured-ldp-sync": "boolean",
"interface-number": "integer",
"designated-router-address": "string",
"transmission-delay": "integer",
"interface-router-id": "string",
"interface-ldp-sync": "boolean",
"interface-dc-bitless-ls-as": "integer",
"ospf-interface-state": "string",
"designated-router-id": "string",
"is-prefix-suppress": "boolean",
"is-interface-lsa-filtered": "boolean",
"hello-interval": "integer",
"next-hello-time": "integer",
"interface-neighbor": [
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
],
"network-lsa-flush-timer": "integer",
"is-interface-demand-circuit": "boolean",
"interface-encryption-transmitted": "integer",
"interface-state": "string",
"wait-interval": "integer",
"is-designated-router": "boolean",
"active-interface": {
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
},
"backup-designated-router-id": "string",
"is-interface-flood-reduction": "boolean",
"is-demand-circuit-configured": "boolean",
"interface-retransmission-interval": "integer",
"interface-authentication-spi": "integer",
"interface-encryption-spi": "integer",
"interface-authentication-transmit": "integer",
"interface-priority": "integer",
"is-interface-line-up": "boolean",
"is-interface-ip-security-required": "boolean"
}
ACTIVE-INTERFACE - Retrieve
Retrieve operation of resource: active-interface
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
}
INTERFACE-BFD - Retrieve
Retrieve operation of resource: interface-bfd
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
}
INTERFACE-NEIGHBOR - Retrieve
Retrieve operation of resource: interface-neighbor
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
FLOOD-LIST-TABLE - Retrieve
Retrieve operation of resource: flood-list-table
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flood": [
{
"interface-name": "string",
"queue-length": "integer",
"as-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"area-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"ls-transmission-timer": "integer",
"link-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
]
}
]
}
FLOOD - Retrieve
Retrieve operation of resource: flood
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"queue-length": "integer",
"as-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"area-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"ls-transmission-timer": "integer",
"link-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
]
}
LINK-FLOOD - Retrieve
Retrieve operation of resource: link-flood
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
AREA-FLOOD - Retrieve
Retrieve operation of resource: area-flood
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
AS-FLOOD - Retrieve
Retrieve operation of resource: as-flood
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
RETRANSMISSION-LIST-TABLE - Retrieve
Retrieve operation of resource: retransmission-list-table
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retransmission": [
{
"neighbor-address": "string",
"interface-name": "string",
"retransmission-area-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-asdb": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-timer": "integer",
"is-retransmissionvirtual-link": "boolean",
"retransmission-length": "integer",
"is-retransmission-sham-link": "boolean",
"retransmissionvirtual-link-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-neighbor-address": "string",
"retransmission-sham-link-id": "integer",
"retransmissionvirtual-link-id": "integer"
}
]
}
RETRANSMISSION - Retrieve
Retrieve operation of resource: retransmission
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retransmission-area-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-asdb": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-timer": "integer",
"is-retransmissionvirtual-link": "boolean",
"retransmission-length": "integer",
"is-retransmission-sham-link": "boolean",
"retransmissionvirtual-link-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-neighbor-address": "string",
"retransmission-sham-link-id": "integer",
"retransmissionvirtual-link-id": "integer"
}
RETRANSMISSIONVIRTUAL-LINK-DB - Retrieve
Retrieve operation of resource: retransmissionvirtual-link-db
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
RETRANSMISSION-AREA-DB - Retrieve
Retrieve operation of resource: retransmission-area-db
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
RETRANSMISSION-ASDB - Retrieve
Retrieve operation of resource: retransmission-asdb
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
DATABASE-TABLE - Retrieve
Retrieve operation of resource: database-table
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-table": {
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer"
}
}
}
}
]
}
}
LSA-TABLE - Retrieve
Retrieve operation of resource: lsa-table
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean"
}
}
}
}
]
}
LSA - Retrieve
Retrieve operation of resource: lsa
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
}
}
LSA-INFO - Retrieve
Retrieve operation of resource: lsa-info
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean"
}
}
LSA-SUMMARY-INFO - Retrieve
Retrieve operation of resource: lsa-summary-info
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-router-id": "integer",
"prefix-length": "integer",
"interface-name": "string",
"links": "integer",
"is-virtual-link": "boolean",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"reference-lsa-id": "integer",
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": "string",
"reference-type": "integer",
"router-la-bits": "integer",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: router-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link": [
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
],
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"router-la-bits": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"rpf-path": {
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
LINK - Retrieve
Retrieve operation of resource: link
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
NETWORK-LSA-TYPE - Retrieve
Retrieve operation of resource: network-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"neighbor-router": [
"string"
],
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-prefix-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"prefix": "string",
"prefix-length": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-router-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"lsa-router-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
EXTERNAL-LSA-TYPE - Retrieve
Retrieve operation of resource: external-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
NSSALSA-TYPE - Retrieve
Retrieve operation of resource: nssalsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: link-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"router-priority": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"lsa-link-local": "string",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
INTRA-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: intra-area-prefix-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reference-lsa-id": "integer",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"reference-advertised-router": "string",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"reference-type": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
GRACE-LSA - Retrieve
Retrieve operation of resource: grace-lsa
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer",
"grace-reason": "string"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-link-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-AREA-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-area-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-ASLSA-TYPE - Retrieve
Retrieve operation of resource: unknown-aslsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
LSA-INTERNAL-TABLE - Retrieve
Retrieve operation of resource: lsa-internal-table
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean"
}
}
}
}
]
}
LSA - Retrieve
Retrieve operation of resource: lsa
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
}
}
LSA-INFO - Retrieve
Retrieve operation of resource: lsa-info
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean"
}
}
LSA-SUMMARY-INFO - Retrieve
Retrieve operation of resource: lsa-summary-info
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-router-id": "integer",
"prefix-length": "integer",
"interface-name": "string",
"links": "integer",
"is-virtual-link": "boolean",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"reference-lsa-id": "integer",
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": "string",
"reference-type": "integer",
"router-la-bits": "integer",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: router-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link": [
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
],
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"router-la-bits": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"rpf-path": {
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
LINK - Retrieve
Retrieve operation of resource: link
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
NETWORK-LSA-TYPE - Retrieve
Retrieve operation of resource: network-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"neighbor-router": [
"string"
],
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-prefix-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"prefix": "string",
"prefix-length": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
INTER-AREA-ROUTER-LSA-TYPE - Retrieve
Retrieve operation of resource: inter-area-router-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"lsa-router-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
EXTERNAL-LSA-TYPE - Retrieve
Retrieve operation of resource: external-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
NSSALSA-TYPE - Retrieve
Retrieve operation of resource: nssalsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: link-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"router-priority": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"lsa-link-local": "string",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
INTRA-AREA-PREFIX-LSA-TYPE - Retrieve
Retrieve operation of resource: intra-area-prefix-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reference-lsa-id": "integer",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"reference-advertised-router": "string",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"reference-type": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
GRACE-LSA - Retrieve
Retrieve operation of resource: grace-lsa
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer",
"grace-reason": "string"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LINK-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-link-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-AREA-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-area-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-ASLSA-TYPE - Retrieve
Retrieve operation of resource: unknown-aslsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
UNKNOWN-LSA-TYPE - Retrieve
Retrieve operation of resource: unknown-lsa-type
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
LSA-HEADER - Retrieve
Retrieve operation of resource: lsa-header
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
LSA-DETAIL - Retrieve
Retrieve operation of resource: lsa-detail
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
DATABASE-SUMMARY-TABLE - Retrieve
Retrieve operation of resource: database-summary-table
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database-summary": {
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
}
DATABASE-SUMMARY - Retrieve
Retrieve operation of resource: database-summary
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
DATABASE-COUNTERS - Retrieve
Retrieve operation of resource: database-counters
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
AREA-DATABASE - Retrieve
Retrieve operation of resource: area-database
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
AREA-DATABASE-SUMMARY - Retrieve
Retrieve operation of resource: area-database-summary
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
INTERNAL-ROUTES - Retrieve
Retrieve operation of resource: internal-routes
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"internal-route": [
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-source": [
{
"route-source-id": "string",
"route-source-lsa-type": "integer",
"route-source-adversting-router": "string"
}
],
"route-area-id": "integer",
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
]
}
INTERNAL-ROUTE - Retrieve
Retrieve operation of resource: internal-route
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-source": [
{
"route-source-id": "string",
"route-source-lsa-type": "integer",
"route-source-adversting-router": "string"
}
],
"route-area-id": "integer",
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
ROUTE-TOPOLOGY - Retrieve
Retrieve operation of resource: route-topology
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
}
ROUTE-SOURCE - Retrieve
Retrieve operation of resource: route-source
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-source-id": "string",
"route-source-lsa-type": "integer",
"route-source-adversting-router": "string"
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
ROUTE-BACKUP-PATH - Retrieve
Retrieve operation of resource: route-backup-path
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
}
NEIGHBOR-NEXT-HOP - Retrieve
Retrieve operation of resource: neighbor-next-hop
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-next-hop-intf-index": "integer"
}
PROTOCOL-AREAS - Retrieve
Retrieve operation of resource: protocol-areas
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-area": [
{
"protocol-interface": [
{
"distribute-list-in": "string",
"interface-name": "string"
}
],
"distribute-list-in": "string",
"protocol-area-id": "string"
}
]
}
PROTOCOL-AREA - Retrieve
Retrieve operation of resource: protocol-area
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-interface": [
{
"distribute-list-in": "string",
"interface-name": "string"
}
],
"distribute-list-in": "string",
"protocol-area-id": "string"
}
PROTOCOL-INTERFACE - Retrieve
Retrieve operation of resource: protocol-interface
process-name
in path
string
ID of process-name
area-id
in path
string
ID of area-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"distribute-list-in": "string",
"interface-name": "string"
}
CONNECTED-ROUTES - Retrieve
Retrieve operation of resource: connected-routes
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"connected-route": [
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
]
}
CONNECTED-ROUTE - Retrieve
Retrieve operation of resource: connected-route
process-name
in path
string
ID of process-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
ROUTE-TOPOLOGY - Retrieve
Retrieve operation of resource: route-topology
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
ROUTE-BACKUP-PATH - Retrieve
Retrieve operation of resource: route-backup-path
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
}
NEIGHBOR-NEXT-HOP - Retrieve
Retrieve operation of resource: neighbor-next-hop
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-next-hop-intf-index": "integer"
}
VRF-STATISTICS - Retrieve
Retrieve operation of resource: vrf-statistics
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf-rib-batch-stats": {
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
}
PROTOCOL-STATS - Retrieve
Retrieve operation of resource: protocol-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-stat": [
{
"ls-req-in-packets": "integer",
"ls-upd-in-ignored": "integer",
"total-out-packets": "integer",
"ls-req-in-ls-as": "integer",
"ls-ack-out-packets": "integer",
"ls-req-out-packets": "integer",
"total-in-packets": "integer",
"ls-ack-in-ls-as": "integer",
"dropped-in-gs": "integer",
"dbdes-in-ls-as": "integer",
"ls-upd-out-ls-as": "integer",
"hello-out-packets": "integer",
"dbdes-out-ls-as": "integer",
"ls-upd-in-packets": "integer",
"checksum-err": "integer",
"ls-upd-out-packets": "integer",
"ls-req-out-ls-as": "integer",
"ls-upd-in-ls-as": "integer",
"dbdes-out-packets": "integer",
"ls-ack-in-packets": "integer",
"ls-ack-out-ls-as": "integer",
"hello-in-packets": "integer",
"dbdes-in-packets": "integer"
}
]
}
PROTOCOL-STAT - Retrieve
Retrieve operation of resource: protocol-stat
process-name
in path
string
ID of process-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ls-req-in-packets": "integer",
"ls-upd-in-ignored": "integer",
"total-out-packets": "integer",
"ls-req-in-ls-as": "integer",
"ls-ack-out-packets": "integer",
"ls-req-out-packets": "integer",
"total-in-packets": "integer",
"ls-ack-in-ls-as": "integer",
"dropped-in-gs": "integer",
"dbdes-in-ls-as": "integer",
"ls-upd-out-ls-as": "integer",
"hello-out-packets": "integer",
"dbdes-out-ls-as": "integer",
"ls-upd-in-packets": "integer",
"checksum-err": "integer",
"ls-upd-out-packets": "integer",
"ls-req-out-ls-as": "integer",
"ls-upd-in-ls-as": "integer",
"dbdes-out-packets": "integer",
"ls-ack-in-packets": "integer",
"ls-ack-out-ls-as": "integer",
"hello-in-packets": "integer",
"dbdes-in-packets": "integer"
}
SPF-STATS - Retrieve
Retrieve operation of resource: spf-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spf-runtime": [
{
"rib-delete-routes": "integer",
"start-time": "integer",
"global-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"lsa": [
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
],
"lsa-changes": "string",
"reason-flags": "string",
"area-stat": [
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
],
"rib-add-routes": "integer"
}
],
"spf-header": {
"area-summary": [
{
"sp-fs": "integer",
"area-id": "integer"
}
],
"header-sp-fs": "integer",
"header-router-id": "string"
}
}
SPF-HEADER - Retrieve
Retrieve operation of resource: spf-header
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-summary": [
{
"sp-fs": "integer",
"area-id": "integer"
}
],
"header-sp-fs": "integer",
"header-router-id": "string"
}
AREA-SUMMARY - Retrieve
Retrieve operation of resource: area-summary
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sp-fs": "integer",
"area-id": "integer"
}
SPF-RUNTIME - Retrieve
Retrieve operation of resource: spf-runtime
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-delete-routes": "integer",
"start-time": "integer",
"global-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"lsa": [
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
],
"lsa-changes": "string",
"reason-flags": "string",
"area-stat": [
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
],
"rib-add-routes": "integer"
}
GLOBAL-TIME - Retrieve
Retrieve operation of resource: global-time
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
}
LSA - Retrieve
Retrieve operation of resource: lsa
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
AREA-STAT - Retrieve
Retrieve operation of resource: area-stat
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
SPF-STAT-TIME - Retrieve
Retrieve operation of resource: spf-stat-time
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
}
RAWIO-STATS - Retrieve
Retrieve operation of resource: rawio-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out-error-drops": "integer",
"in-short-drops": "integer",
"out-bytes": "integer",
"in-bytes": "integer",
"in-queue-drops": "integer",
"out-nopak-drops": "integer",
"raw-conn-open": "integer",
"raw-conn-close": "integer",
"in-long-packets": "integer",
"in-handle-drops": "integer",
"in-error-drops": "integer",
"raw-conn-state": "integer",
"out-pakapi-errors": "integer",
"in-packets": "integer",
"in-malloc-drops": "integer",
"out-nofd-drops": "integer",
"raw-conn-error": "integer",
"in-ipsec-drops": "integer",
"out-ipsec-drops": "integer",
"out-packets": "integer"
}
PREFIX-PRIORITY-STATS - Retrieve
Retrieve operation of resource: prefix-priority-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"high": "integer",
"medium": "integer",
"critical": "integer",
"low": "integer"
}
VRF-RIB-BATCH-STATS - Retrieve
Retrieve operation of resource: vrf-rib-batch-stats
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route": {
"total-sent-route": "integer",
"inter-area-route": "integer",
"nssa-two-route": "integer",
"extern-two-route": "integer",
"route-connected": "integer",
"redistribution-route": "integer",
"intra-area-route": "integer",
"nssa-one-route": "integer",
"extern-one-route": "integer",
"total-received-route": "integer",
"route-id": "string"
},
"protocol": {
"administrative-distance-inter-area": "integer",
"protocol-router-id": "string",
"is-graceful-restart": "boolean",
"administrative-distance": "integer",
"administrative-distance-external": "integer",
"distribute-list-in": "string"
},
"ospfv3": {
"is-nsr-enabled": "boolean",
"normal-areas": "integer",
"is-router-id-stalled": "boolean",
"last-nsf-time": "integer",
"lsa-hold-time": "integer",
"metric": "integer",
"is-grace-restart-enabled": "boolean",
"stub-areas": "integer",
"grace-resync-time": "integer",
"ipfrr-tiebreakers": [
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
],
"snmp-trap-enabled": "boolean",
"spf-start-time": "integer",
"default-metric": "integer",
"as-dc-bitless-ls-as": "integer",
"router-id": "string",
"spf-hold-time": "integer",
"context-name": "string",
"reference-bandwidth": "integer",
"as-lsa-flood-list-length": "integer",
"domain-id": {
"secondary-domain-id": [
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
],
"primary-domain-id": {
"domain-id-type": "integer",
"domain-id-value": "string"
}
},
"role": "integer",
"lsa-maximum-time": "integer",
"default-tag": "integer",
"is-default-originated": "boolean",
"is-opaque-capable": "boolean",
"opaque-lsas": "integer",
"is-nsr-switchover-on-restart": "boolean",
"is-area-border-router": "boolean",
"spf-maximum-time": "integer",
"maximum-paths": "integer",
"nssa-areas": "integer",
"lsa-retransmission-pacing-interval": "integer",
"default-metric-type": "string",
"minimum-lsa-interval": "integer",
"maximum-interfaces": "integer",
"redistribution-threshold": "integer",
"is-role-standby": "boolean",
"as-ls-as": "integer",
"lsa-group-interval": "integer",
"lsa-flood-pacing-interval": "integer",
"is-auto-cost": "boolean",
"redistribution-limit": "integer",
"areas": "integer",
"is-as-border-router": "boolean",
"opaque-lsa-checksum": "integer",
"stub-router": [
{
"remaining-time": "integer",
"include-stub-links": "boolean",
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"summary-lsa-metric": "integer",
"abr-off-reason": "string",
"external-lsa-metric": "integer"
}
]
}
}
PROTOCOL - Retrieve
Retrieve operation of resource: protocol
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"administrative-distance-inter-area": "integer",
"protocol-router-id": "string",
"is-graceful-restart": "boolean",
"administrative-distance": "integer",
"administrative-distance-external": "integer",
"distribute-list-in": "string"
}
OSPFV3 - Retrieve
Retrieve operation of resource: ospfv3
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-nsr-enabled": "boolean",
"normal-areas": "integer",
"is-router-id-stalled": "boolean",
"last-nsf-time": "integer",
"lsa-hold-time": "integer",
"metric": "integer",
"is-grace-restart-enabled": "boolean",
"stub-areas": "integer",
"grace-resync-time": "integer",
"ipfrr-tiebreakers": [
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
],
"snmp-trap-enabled": "boolean",
"spf-start-time": "integer",
"default-metric": "integer",
"as-dc-bitless-ls-as": "integer",
"router-id": "string",
"spf-hold-time": "integer",
"context-name": "string",
"reference-bandwidth": "integer",
"as-lsa-flood-list-length": "integer",
"domain-id": {
"secondary-domain-id": [
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
],
"primary-domain-id": {
"domain-id-type": "integer",
"domain-id-value": "string"
}
},
"role": "integer",
"lsa-maximum-time": "integer",
"default-tag": "integer",
"is-default-originated": "boolean",
"is-opaque-capable": "boolean",
"opaque-lsas": "integer",
"is-nsr-switchover-on-restart": "boolean",
"is-area-border-router": "boolean",
"spf-maximum-time": "integer",
"maximum-paths": "integer",
"nssa-areas": "integer",
"lsa-retransmission-pacing-interval": "integer",
"default-metric-type": "string",
"minimum-lsa-interval": "integer",
"maximum-interfaces": "integer",
"redistribution-threshold": "integer",
"is-role-standby": "boolean",
"as-ls-as": "integer",
"lsa-group-interval": "integer",
"lsa-flood-pacing-interval": "integer",
"is-auto-cost": "boolean",
"redistribution-limit": "integer",
"areas": "integer",
"is-as-border-router": "boolean",
"opaque-lsa-checksum": "integer",
"stub-router": [
{
"remaining-time": "integer",
"include-stub-links": "boolean",
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"summary-lsa-metric": "integer",
"abr-off-reason": "string",
"external-lsa-metric": "integer",
"trigger": [
{
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"trigger": "string",
"unset-reason": "string",
"time": "integer",
"wait-for-bgp": "boolean"
}
],
"abr-resume-time": {
"second": "integer",
"nanosecond": "integer"
},
"mode": "string",
"active": "boolean",
"unset-reason": "string",
"set-reason": "string"
}
]
}
DOMAIN-ID - Retrieve
Retrieve operation of resource: domain-id
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"secondary-domain-id": [
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
],
"primary-domain-id": {
"domain-id-type": "integer",
"domain-id-value": "string"
}
}
PRIMARY-DOMAIN-ID - Retrieve
Retrieve operation of resource: primary-domain-id
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
SECONDARY-DOMAIN-ID - Retrieve
Retrieve operation of resource: secondary-domain-id
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
STUB-ROUTER - Retrieve
Retrieve operation of resource: stub-router
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remaining-time": "integer",
"include-stub-links": "boolean",
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"summary-lsa-metric": "integer",
"abr-off-reason": "string",
"external-lsa-metric": "integer",
"trigger": [
{
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"trigger": "string",
"unset-reason": "string",
"time": "integer",
"wait-for-bgp": "boolean"
}
],
"abr-resume-time": {
"second": "integer",
"nanosecond": "integer"
},
"mode": "string",
"active": "boolean",
"unset-reason": "string",
"set-reason": "string"
}
UNSET-TIME - Retrieve
Retrieve operation of resource: unset-time
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
START-TIME - Retrieve
Retrieve operation of resource: start-time
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
ABR-RESUME-TIME - Retrieve
Retrieve operation of resource: abr-resume-time
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
TRIGGER - Retrieve
Retrieve operation of resource: trigger
process-name
in path
string
ID of process-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"trigger": "string",
"unset-reason": "string",
"time": "integer",
"wait-for-bgp": "boolean"
}
UNSET-TIME - Retrieve
Retrieve operation of resource: unset-time
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
START-TIME - Retrieve
Retrieve operation of resource: start-time
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
IPFRR-TIEBREAKERS - Retrieve
Retrieve operation of resource: ipfrr-tiebreakers
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
ROUTE - Retrieve
Retrieve operation of resource: route
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-sent-route": "integer",
"inter-area-route": "integer",
"nssa-two-route": "integer",
"extern-two-route": "integer",
"route-connected": "integer",
"redistribution-route": "integer",
"intra-area-route": "integer",
"nssa-one-route": "integer",
"extern-one-route": "integer",
"total-received-route": "integer",
"route-id": "string"
}
RETRANSMISSION-LIST-PROCESS-TABLE - Retrieve
Retrieve operation of resource: retransmission-list-process-table
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retransmission": [
{
"neighbor-address": "string",
"interface-name": "string",
"retransmission-area-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-asdb": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-timer": "integer",
"is-retransmissionvirtual-link": "boolean",
"retransmission-length": "integer",
"is-retransmission-sham-link": "boolean",
"retransmissionvirtual-link-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-neighbor-address": "string",
"retransmission-sham-link-id": "integer",
"retransmissionvirtual-link-id": "integer"
}
]
}
RETRANSMISSION - Retrieve
Retrieve operation of resource: retransmission
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retransmission-area-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-asdb": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-timer": "integer",
"is-retransmissionvirtual-link": "boolean",
"retransmission-length": "integer",
"is-retransmission-sham-link": "boolean",
"retransmissionvirtual-link-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-neighbor-address": "string",
"retransmission-sham-link-id": "integer",
"retransmissionvirtual-link-id": "integer"
}
RETRANSMISSIONVIRTUAL-LINK-DB - Retrieve
Retrieve operation of resource: retransmissionvirtual-link-db
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
RETRANSMISSION-AREA-DB - Retrieve
Retrieve operation of resource: retransmission-area-db
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
RETRANSMISSION-ASDB - Retrieve
Retrieve operation of resource: retransmission-asdb
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
BAD-CHECKSUMS - Retrieve
Retrieve operation of resource: bad-checksums
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bad-checksum": [
{
"timestamp": {
"second": "integer",
"nanosecond": "integer"
},
"computed-checksum": "integer",
"received-data": "string",
"received-checksum": "integer"
}
]
}
BAD-CHECKSUM - Retrieve
Retrieve operation of resource: bad-checksum
process-name
in path
string
ID of process-name
packet-number
in path
string
ID of packet-number
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"timestamp": {
"second": "integer",
"nanosecond": "integer"
},
"computed-checksum": "integer",
"received-data": "string",
"received-checksum": "integer"
}
TIMESTAMP - Retrieve
Retrieve operation of resource: timestamp
process-name
in path
string
ID of process-name
packet-number
in path
string
ID of packet-number
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"second": "integer",
"nanosecond": "integer"
}
DATABASE-SUMMARY-TABLE - Retrieve
Retrieve operation of resource: database-summary-table
process-name
in path
string
ID of process-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database-summary": {
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
}
DATABASE-SUMMARY - Retrieve
Retrieve operation of resource: database-summary
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
DATABASE-COUNTERS - Retrieve
Retrieve operation of resource: database-counters
process-name
in path
string
ID of process-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
AREA-DATABASE - Retrieve
Retrieve operation of resource: area-database
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
AREA-DATABASE-SUMMARY - Retrieve
Retrieve operation of resource: area-database-summary
process-name
in path
string
ID of process-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
NEIGHBOR-PROCESS-TABLE - Retrieve
Retrieve operation of resource: neighbor-process-table
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: neighbor-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
}
NEIGHBOR-RETRANSMISSION - Retrieve
Retrieve operation of resource: neighbor-retransmission
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
NEIGHBOR-BFD-INFO - Retrieve
Retrieve operation of resource: neighbor-bfd-info
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
}
FAST-REROUTES - Retrieve
Retrieve operation of resource: fast-reroutes
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fast-reroute": [
{
"ipfrr-router-id": "string",
"ipfrr-area-revision": "integer",
"ipfrr-topo": [
{
"distance": "integer",
"neighbor-sourced": "boolean",
"lsaid": "integer",
"type4": "boolean",
"dr": "boolean",
"node-id": "string",
"revision": "integer"
}
],
"ipfrr-topo-area-id": "string"
}
]
}
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipfrr-router-id": "string",
"ipfrr-area-revision": "integer",
"ipfrr-topo": [
{
"distance": "integer",
"neighbor-sourced": "boolean",
"lsaid": "integer",
"type4": "boolean",
"dr": "boolean",
"node-id": "string",
"revision": "integer"
}
],
"ipfrr-topo-area-id": "string"
}
IPFRR-TOPO - Retrieve
Retrieve operation of resource: ipfrr-topo
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"distance": "integer",
"neighbor-sourced": "boolean",
"lsaid": "integer",
"type4": "boolean",
"dr": "boolean",
"node-id": "string",
"revision": "integer"
}
INTERFACE-BRIEF-PROCESS-TABLE - Retrieve
Retrieve operation of resource: interface-brief-process-table
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-brief": [
{
"interface-name": "string",
"interface-neighbors": "integer",
"interface-link-cost": "integer",
"interface-adjacent-neighbors": "integer",
"interface-address": "string",
"network-type": "string",
"ospf-interface-state": "string"
}
]
}
INTERFACE-BRIEF - Retrieve
Retrieve operation of resource: interface-brief
process-name
in path
string
ID of process-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbors": "integer",
"interface-link-cost": "integer",
"interface-adjacent-neighbors": "integer",
"interface-address": "string",
"network-type": "string",
"ospf-interface-state": "string"
}
NEIGHBOR-DETAIL-PROCESS-TABLE - Retrieve
Retrieve operation of resource: neighbor-detail-process-table
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-detail": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: neighbor-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: neighbor-detail
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
}
NEIGHBOR-RETRANSMISSION - Retrieve
Retrieve operation of resource: neighbor-retransmission
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
NEIGHBOR-BFD-INFO - Retrieve
Retrieve operation of resource: neighbor-bfd-info
process-name
in path
string
ID of process-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
}
Schema Definitions
OSPFV3-EDM-INTERFACE-UP:
OSPFv3 interface up-only information
- interface-neighbors: integer
-
Total number of neighbors
- suppressed-hellos: integer
-
Number of neighbors for which hellos are suppressed
- maximum-flood-length: integer
-
Maximum flood length
- interface-flood-pacing-timer: integer
-
Time until next flood pacing timer (ms)
- interface-link-next-index: integer
-
Interface link next information index
- interface-area-next-flood: integer
-
Next LSA to flood (Area scope)
- last-flood-time: integer
-
Last flood scan time (ms)
- flood-queue-length: integer
-
Flood queue length
- wait-time: integer
-
Wait time for DR/BDR selection (s)
- interface-link-flood-index: integer
-
Interface flood link index
- interface-area-next-flood-index: integer
-
Index of next LSA to flood (Area scope)
- interface-area-flood-index: integer
-
Area scope LSAs flood index
- interface-as-next-flood: integer
-
Next LSA to flood (AS scope)
- interface-as-next-flood-index: integer
-
Index of next LSA to flood (AS scope)
- interface-link-next-flood: integer
-
Interface link next flood information
- maximum-flood-time: integer
-
Maximum flood time (ms)
- flood-scan-length: integer
-
Last flood scan length
- interface-as-flood-index: integer
-
AS scope LSAs flood index
Example
{
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
}
FLOOD-LIST:
Common node of flood-list-table, flood-list-process-table
- flood: object[]
-
OSPFv3 flood list information
Example
{
"flood": [
{
"interface-name": "string",
"queue-length": "integer",
"as-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"area-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"ls-transmission-timer": "integer",
"link-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
]
}
]
}
OSPFV3-EDM-INTERFACE-NBR:
OSPFv3 interface neighbor information
- is-hello-suppressed: boolean
-
If true, hello is suppressed
- interface-neighbor-id: string
-
Neighbor router ID
- is-neighbor-dr: boolean
-
If true, designated router is found
- interface-neighbor-cost: integer
-
Cost of link to neighbor
- is-neighbor-bdr: boolean
-
If true, backup designated router is found
Example
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
VIRTUAL-LINK:
Common node of default-vrf, vrf
- virtual-link: OSPFV3-EDM-VIRTUAL-LINKS
-
Virtual link information
Example
{
"virtual-link": {
"is-virtual-link-ip-security-required": "boolean",
"virtual-link-dc-bitless-lsa": "integer",
"virtual-link-cost": "integer",
"virtual-link-neighbor-id": "string",
"virtual-link-encrypted-authentication-transmitted": "integer",
"virtual-link-next-hello": "integer",
"virtual-link-dead-interval": "integer",
"is-virtual-link-demand-circuit": "boolean",
"virtual-link-hello-interval": "integer",
"virtual-link-state": "string",
"virtual-link-encryption-spi": "integer",
"virtual-link-wait-interval": "integer",
"virtual-link-neighbor": {
"virtual-link-state": "string",
"is-virtual-link-hello-suppressed": "boolean",
"virtual-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
},
"virtual-link-authentication-spi": "integer",
"virtual-link-retransmission-interval": "integer",
"virtual-link-encryption-transmitted": "integer",
"is-virtual-link-encryption-enabled": "boolean",
"virtual-link-neighbor-address": "string",
"transit-area-id": "string",
"is-virtual-link-authentication-enabled": "boolean",
"interface-name": "string",
"virual-link-transmission-delay": "integer",
"virtual-link-authentication-transmit": "integer",
"is-virtual-link-ip-security-active": "boolean",
"is-virtual-link-passive": "boolean",
"virtual-link-interface-number": "integer"
}
}
NEIGHBOR-DETAIL:
Common node of neighbor-detail-process-table, neighbor-detail-table
- neighbor-detail: object[]
-
OSPFv3 neighbor detail information
Example
{
"neighbor-detail": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
OSPF-SH-NSR-STATS-PRI:
OSPF SH NSR STATS PRI
- nsr-sched-evs-qd: integer
-
Events queued
- nsr-sched-pri: string ospf-nsr-stats-sched-pri-hi, ospf-nsr-stats-sched-pri-med, ospf-nsr-stats-sched-pri-low, ospf-nsr-stats-sched-pri-max
-
Priority Type
- nsr-sched-max-evs: integer
-
Max Queued
- nsr-sched-evs-in-q: integer
-
Events pending
- nsr-sched-evs-deqd: integer
-
Events dequeued
- nsr-sched-peak-q-len: integer
-
Peak queue length
- nsr-sched-remain-quant: integer
-
Remaining quantum
- nsr-sched-quant: integer
-
Priority Queue
- nsr-sched-enq-fails: integer
-
Event enqueue fails
Example
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
OSPFV3-SH-STUB-ROUTER-TRIGGER:
OSPFv3 stub router trigger information
- start-time: OSPFV3-EDM-TIME
-
Timestamp (relative to 1970/1/1 00:00) when stub router mode was activated
- unset-time: OSPFV3-EDM-TIME
-
Timestamp (relative to 1970/1/1 00:00) when stub router condition was cleared
- trigger: string on-proc-migration, on-proc-restart, on-switchover, on-startup, always, none
-
Stub Router Trigger type
- unset-reason: string none, bgp, timer, configuration, cleared, override
-
Reason for clearing stub router condition
- time: integer
-
Time (in seconds) to stay in stub router mode
- wait-for-bgp: boolean
-
If true, stub router is terminated when BGP converges
Example
{
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"trigger": "string",
"unset-reason": "string",
"time": "integer",
"wait-for-bgp": "boolean"
}
PROTOCOL-STATS-TABLE:
Common node of statistics, vrf-statistics
- protocol-stats: object
-
Protocol table
Example
{
"protocol-stats": {
"protocol-stat": [
{
"interface-name": "string",
"ls-req-in-packets": "integer",
"ls-upd-in-ignored": "integer",
"total-out-packets": "integer",
"ls-req-in-ls-as": "integer",
"ls-ack-out-packets": "integer",
"ls-req-out-packets": "integer",
"total-in-packets": "integer",
"ls-ack-in-ls-as": "integer",
"dropped-in-gs": "integer",
"dbdes-in-ls-as": "integer",
"ls-upd-out-ls-as": "integer",
"hello-out-packets": "integer",
"dbdes-out-ls-as": "integer",
"ls-upd-in-packets": "integer",
"checksum-err": "integer",
"ls-upd-out-packets": "integer",
"ls-req-out-ls-as": "integer",
"ls-upd-in-ls-as": "integer",
"dbdes-out-packets": "integer",
"ls-ack-in-packets": "integer",
"ls-ack-out-ls-as": "integer",
"hello-in-packets": "integer",
"dbdes-in-packets": "integer"
}
]
}
}
OSPFV3-SH-STUB-ROUTER:
OSPFv3 Stub Router Information
- remaining-time: integer
-
Remaining time (in seconds) in stub router mode
- include-stub-links: boolean
-
If true, advertise maximum metric for stub links
- start-time: OSPFV3-EDM-TIME
-
Timestamp (relative to 1970/1/1 00:00) when stub router mode was activated
- unset-time: OSPFV3-EDM-TIME
-
Timestamp (relative to 1970/1/1 00:00) when stub router condition was cleared
- summary-lsa-metric: integer
-
Metric for summary LSAs in max-metric mode
- abr-off-reason: string init-delay, no-neighbor, no-full-neighbor, new-neighbor, full-neighbor
-
Reason for being in ABR off mode
- external-lsa-metric: integer
-
Metric for external LSAs in max-metric mode
- trigger: OSPFV3-SH-STUB-ROUTER-TRIGGER
-
Triggers for entering stub router mode
- abr-resume-time: OSPFV3-EDM-TIME
-
Timestamp (relative to 1970/1/1 00:00) when ABR duties were resumed
- mode: string rbit, v6bit, max-metric, none
-
Stub router mode
- active: boolean
-
If true, stub router mode is active
- unset-reason: string none, bgp, timer, configuration, cleared, override
-
Reason for clearing stub router condition
- set-reason: string on-proc-migration, on-proc-restart, on-switchover, on-startup, always, none
-
Reason for entering stub router mode
Example
{
"remaining-time": "integer",
"include-stub-links": "boolean",
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"summary-lsa-metric": "integer",
"abr-off-reason": "string",
"external-lsa-metric": "integer",
"trigger": [
{
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"trigger": "string",
"unset-reason": "string",
"time": "integer",
"wait-for-bgp": "boolean"
}
],
"abr-resume-time": {
"second": "integer",
"nanosecond": "integer"
},
"mode": "string",
"active": "boolean",
"unset-reason": "string",
"set-reason": "string"
}
OSPFV3-EDM-INTF-BRIEF:
OSPFv3 brief interface information
- interface-neighbors: integer
-
Total number of neighbors
- interface-link-cost: integer
-
Interface link cost
- interface-adjacent-neighbors: integer
-
Total number of adjacent neighbors
- interface-address: string
-
Interface IP address
- network-type: string none, broadcast, non-broadcast, point-to-point, point-to-multipoint, point-to-multipoint-non-broadcast, virtual-link, loopback-interface, mpls-traffic-engineering, sham-link
-
Network type
- ospf-interface-state: string down, loopback, waiting, point-to-multipoint, point-to-point, designated-router, backup-designated-router, other-designated-router
-
Interface OSPF state
Example
{
"interface-neighbors": "integer",
"interface-link-cost": "integer",
"interface-adjacent-neighbors": "integer",
"interface-address": "string",
"network-type": "string",
"ospf-interface-state": "string"
}
RETRANSMISSION-LIST:
Common node of retransmission-list-process-table, retransmission-list-table
- retransmission: object[]
-
OSPFv3 retransmission list information
Example
{
"retransmission": [
{
"neighbor-address": "string",
"interface-name": "string",
"retransmission-area-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-asdb": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-timer": "integer",
"is-retransmissionvirtual-link": "boolean",
"retransmission-length": "integer",
"is-retransmission-sham-link": "boolean",
"retransmissionvirtual-link-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-neighbor-address": "string",
"retransmission-sham-link-id": "integer",
"retransmissionvirtual-link-id": "integer"
}
]
}
NEIGHBOR:
Common node of neighbor-process-table, neighbor-table
- neighbor: object[]
-
OSPFv3 neighbor detail information
Example
{
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
OSPFV3-EDM-NEIGHBOR-BFD:
OSPFv3 Neighbor BFD information
- bfd-status-flag: integer
-
Status of the BFD Session
- bfd-intf-enable-mode: integer
-
BFD enable mode - Default/Strict
Example
{
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
}
OSPFV3-EDM-LSA-LINK:
OSPFv3 Link LSA
- interface-name: string
-
LSA interface handle
- router-priority: integer
-
Router priority
- lsa-header: OSPFV3-EDM-DB-HEADER
-
Header information
- is-sham-link: boolean
-
If true, it is a sham link
- lsa-detail: OSPFV3-EDM-DB-DETAIL
-
Detailed LSA information
- virtual-link-id: integer
-
Virtual link ID
- prefix: OSPFV3-EDM-PREFIX
-
OSPFv3 prefix
- lsa-link-local: string
-
LSA link local
- is-virtual-link: boolean
-
If true, it is a virtual link
- sham-link-id: integer
-
Sham link ID
Example
{
"interface-name": "string",
"router-priority": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"lsa-link-local": "string",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
SPF-STATS:
Common node of statistics, vrf-statistics
- spf-stats: OSPFV3-EDM-SPF-STATS
-
OSPFv3 RIB batch statistics
Example
{
"spf-stats": {
"spf-runtime": [
{
"rib-delete-routes": "integer",
"start-time": "integer",
"global-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"lsa": [
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
],
"lsa-changes": "string",
"reason-flags": "string",
"area-stat": [
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
],
"rib-add-routes": "integer"
}
],
"spf-header": {
"area-summary": [
{
"sp-fs": "integer",
"area-id": "integer"
}
],
"header-sp-fs": "integer",
"header-router-id": "string"
}
}
}
OSPFV3-EDM-TOP-SOURCE:
OSPFv3 topology source information
- route-source-id: string
-
Route source ID
- route-source-lsa-type: integer
-
Type of LSA advertising the prefix, see RFC5340
- route-source-adversting-router: string
-
Route source of the advertising router
Example
{
"route-source-id": "string",
"route-source-lsa-type": "integer",
"route-source-adversting-router": "string"
}
REDISTRIBUTION-TABLE:
Common node of default-vrf, vrf
- redistributions: object
-
Redistribution information table
Example
{
"redistributions": {
"redistribution": [
{
"protocol-name": "string",
"process-name": "string",
"red-metric": "integer",
"policy-name": "string",
"red-tag": "integer",
"red-metric-type": "integer",
"red-metric-flag": "boolean",
"red-mtype-flag": "boolean",
"process-id": "string",
"protocol-name-xr": "string"
}
]
}
}
RAWIO-STATS:
Common node of statistics, vrf-statistics
- rawio-stats: OSPFV3-EDM-RAW-STATS
-
OSPF Prefix SPF Prioritization statistics
Example
{
"rawio-stats": {
"out-error-drops": "integer",
"in-short-drops": "integer",
"out-bytes": "integer",
"in-bytes": "integer",
"in-queue-drops": "integer",
"out-nopak-drops": "integer",
"raw-conn-open": "integer",
"raw-conn-close": "integer",
"in-long-packets": "integer",
"in-handle-drops": "integer",
"in-error-drops": "integer",
"raw-conn-state": "integer",
"out-pakapi-errors": "integer",
"in-packets": "integer",
"in-malloc-drops": "integer",
"out-nofd-drops": "integer",
"raw-conn-error": "integer",
"in-ipsec-drops": "integer",
"out-ipsec-drops": "integer",
"out-packets": "integer"
}
}
OSPFV3-NSR-ERR-BLOCK-BAG:
OSPFV3 NSR ERR BLOCK BAG
- nsr-error-info: OSPFV3-NSR-ERR-INFO-BAG
-
List of erros
- nsr-revisionversion: integer
-
Nsr Revision version
- total-errors: string
-
Total errors for this nsr revision version
Example
{
"nsr-error-info": [
{
"last-err-time": {
"second": "integer",
"nanosecond": "integer"
},
"err-info-string": "string",
"err-count": "string"
}
],
"nsr-revisionversion": "integer",
"total-errors": "string"
}
OSPFV3-EDM-RTHREAD-STATS:
OSPFv3 RIB thread statistics
- rib-batch-limit: integer
-
Rib Batches Limit
- rib-batch-purged: integer
-
No. of Rib batches purged
- rib-route-some-err: integer
-
Route some errors
- rib-batch-ok: integer
-
Rib Batches Ok
- holdq: OSPFV3-EDM-RTHREAD-QUEUE-STATS
-
holdq
- rib-batch-some-err: integer
-
Batches with some error
- rib-path-limit: integer
-
Route path limits
- thread-q: OSPFV3-EDM-RTHREAD-QUEUE-STATS
-
Inter Thread Queue
- rib-batch-backup: integer
-
Rib Batches Back up
- rib-route-err: integer
-
Route Errors
- rib-drop-version: integer
-
Rib drop version
- wq-signals: integer
-
Signals sent to RIB Thread
- wq-thread-active: boolean
-
RIB Thread Active Indicator
- rib-base-time: OSPFV3-EDM-TIME
-
rib base time
- rib-drop-conn: integer
-
Rib drop connections
- rib-batch-sent: integer
-
No. of Rib batches sent
- rib-batch-no-table: integer
-
Batches no table
- rib-route-limit: integer
-
Route table limit
- rib-sum-latency: integer
-
Sum latencies to calc average
- rib-base-clock: integer
-
Rib Base Clock
- rib-path-err: integer
-
Route path errors
- rib-max-latency: integer
-
Max time entry was in queue
- rib-batch-err: integer
-
Batch errors
Example
{
"rib-batch-limit": "integer",
"rib-batch-purged": "integer",
"rib-route-some-err": "integer",
"rib-batch-ok": "integer",
"holdq": [
{
"wq-len-max": "string",
"wq-total-dequeued": "integer",
"wq-sum-latency": "integer",
"wq-first-eqtime": "integer",
"wq-dequeue-errs": "integer",
"wq-total-enqueued": "integer",
"wq-len-cur": "string",
"wq-dqtime": "integer",
"wq-eqtime": "integer",
"wq-max-latency": "integer",
"wq-eneueue-errs": "integer"
}
],
"rib-batch-some-err": "integer",
"rib-path-limit": "integer",
"thread-q": {
"wq-len-max": "string",
"wq-total-dequeued": "integer",
"wq-sum-latency": "integer",
"wq-first-eqtime": "integer",
"wq-dequeue-errs": "integer",
"wq-total-enqueued": "integer",
"wq-len-cur": "string",
"wq-dqtime": "integer",
"wq-eqtime": "integer",
"wq-max-latency": "integer",
"wq-eneueue-errs": "integer"
},
"rib-batch-backup": "integer",
"rib-route-err": "integer",
"rib-drop-version": "integer",
"wq-signals": "integer",
"wq-thread-active": "boolean",
"rib-base-time": {
"second": "integer",
"nanosecond": "integer"
},
"rib-drop-conn": "integer",
"rib-batch-sent": "integer",
"rib-batch-no-table": "integer",
"rib-route-limit": "integer",
"rib-sum-latency": "integer",
"rib-base-clock": "integer",
"rib-path-err": "integer",
"rib-max-latency": "integer",
"rib-batch-err": "integer"
}
OSPFV3-EDM-SUMMARY:
OSPFv3 summary
- is-nsr-enabled: boolean
-
If true, NSR is enabled
- normal-areas: integer
-
Number of normal areas
- is-router-id-stalled: boolean
-
Stalled Router ID
- last-nsf-time: integer
-
Length of time since the last NSF (s)
- lsa-hold-time: integer
-
Second delay before generating next LSA (ms)
- metric: integer
-
Redistribution metric
- is-grace-restart-enabled: boolean
-
If true, grace restart is enabled
- stub-areas: integer
-
Number of stub and total stub areas
- grace-resync-time: integer
-
Grace time to resync
- ipfrr-tiebreakers: OSPF-SH-IPFRR-TB
-
IPFRR-Tiebreakers list
- snmp-trap-enabled: boolean
-
If true, snmp trap is enabled
- spf-start-time: integer
-
Scheduling delay for SPF (ms)
- default-metric: integer
-
Default metric
- as-dc-bitless-ls-as: integer
-
Number of external and AS opaque LSAs with demand circut bit not set
- router-id: string
-
Router ID
- spf-hold-time: integer
-
Minimum delay time between SPF runs (ms)
- context-name: string
-
Context name
- reference-bandwidth: integer
-
Reference Bandwdith
- as-lsa-flood-list-length: integer
-
Length of AS LSAs flood list
- domain-id: OSPFV3-SH-DOMAIN-ID
-
Domain ID information
- role: integer
-
Role, V1/V2 Active/Standby
- lsa-maximum-time: integer
-
Maximum delay before generating an LSA (ms)
- default-tag: integer
-
Default tag
- is-default-originated: boolean
-
If true, origin is by default
- is-opaque-capable: boolean
-
Opaque LSA capable
- opaque-lsas: integer
-
Number of opaque LSAs
- is-nsr-switchover-on-restart: boolean
-
Trigger RP Switchover on detectable process restart
- is-area-border-router: boolean
-
If true, is an area border router
- spf-maximum-time: integer
-
Maximum delay time between SPF runs (ms)
- maximum-paths: integer
-
Maximum number of paths
- nssa-areas: integer
-
Number of NSSA areas
- lsa-retransmission-pacing-interval: integer
-
LSA retransmission pacing timer (ms)
- default-metric-type: string type-none, type1, type2
-
Default metric type
- minimum-lsa-interval: integer
-
Minimum time between LSA regeneration (ms)
- maximum-interfaces: integer
-
Maximum number of interfaces
- redistribution-threshold: integer
-
When the number of redistributed prefixes reaches this threshold, a warning message is issued
- is-role-standby: boolean
-
If true, the process is running as stanby role
- as-ls-as: integer
-
Number of AS scope LSAs
- lsa-group-interval: integer
-
LSA refresh interval (sec)
- lsa-flood-pacing-interval: integer
-
LSA flood pacing timer (ms)
- is-auto-cost: boolean
-
If true, auto cost is enabled
- redistribution-limit: integer
-
The number of redistributed prefixes allowed
- areas: integer
-
Number of areas
- is-as-border-router: boolean
-
If true, is an AS border router
- opaque-lsa-checksum: integer
-
Sum of opaque LSA checksum
- stub-router: OSPFV3-SH-STUB-ROUTER
-
Stub Router Information
- is-default-policy: boolean
-
If true, is a default policy
- graceful-shutdown-state: string init, normal, flushing, empty-hellos, quiet
-
Graceful shutdown state
- default-policy-name: string
-
Default policy name
- as-do-not-age-ls-as: integer
-
Number of external and AS opaque LSAs with do not age set
- lsa-start-time: integer
-
Initial LSA throttle delay (ms)
- capability-prefer-type7: boolean
-
If true, prefer type 7 LSAs over type 5
- is-default-always: boolean
-
If true, default always
Example
{
"is-nsr-enabled": "boolean",
"normal-areas": "integer",
"is-router-id-stalled": "boolean",
"last-nsf-time": "integer",
"lsa-hold-time": "integer",
"metric": "integer",
"is-grace-restart-enabled": "boolean",
"stub-areas": "integer",
"grace-resync-time": "integer",
"ipfrr-tiebreakers": [
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
],
"snmp-trap-enabled": "boolean",
"spf-start-time": "integer",
"default-metric": "integer",
"as-dc-bitless-ls-as": "integer",
"router-id": "string",
"spf-hold-time": "integer",
"context-name": "string",
"reference-bandwidth": "integer",
"as-lsa-flood-list-length": "integer",
"domain-id": {
"secondary-domain-id": [
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
],
"primary-domain-id": {
"domain-id-type": "integer",
"domain-id-value": "string"
}
},
"role": "integer",
"lsa-maximum-time": "integer",
"default-tag": "integer",
"is-default-originated": "boolean",
"is-opaque-capable": "boolean",
"opaque-lsas": "integer",
"is-nsr-switchover-on-restart": "boolean",
"is-area-border-router": "boolean",
"spf-maximum-time": "integer",
"maximum-paths": "integer",
"nssa-areas": "integer",
"lsa-retransmission-pacing-interval": "integer",
"default-metric-type": "string",
"minimum-lsa-interval": "integer",
"maximum-interfaces": "integer",
"redistribution-threshold": "integer",
"is-role-standby": "boolean",
"as-ls-as": "integer",
"lsa-group-interval": "integer",
"lsa-flood-pacing-interval": "integer",
"is-auto-cost": "boolean",
"redistribution-limit": "integer",
"areas": "integer",
"is-as-border-router": "boolean",
"opaque-lsa-checksum": "integer",
"stub-router": [
{
"remaining-time": "integer",
"include-stub-links": "boolean",
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"summary-lsa-metric": "integer",
"abr-off-reason": "string",
"external-lsa-metric": "integer",
"trigger": [
{
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"trigger": "string",
"unset-reason": "string",
"time": "integer",
"wait-for-bgp": "boolean"
}
],
"abr-resume-time": {
"second": "integer",
"nanosecond": "integer"
},
"mode": "string",
"active": "boolean",
"unset-reason": "string",
"set-reason": "string"
}
],
"is-default-policy": "boolean"
}
OSPFV3-EDM-DATABASE:
OSPFv3 Database Information
- lsa-router-id: integer
-
LSA router ID
- prefix-length: integer
-
Prefix length
- interface-name: string
-
LSA interface name
- links: integer
-
Number of links
- is-virtual-link: boolean
-
If true, it is a virtual link
- lsa-header: OSPFV3-EDM-DB-HEADER
-
Header information
- reference-lsa-id: integer
-
Reference LSA ID
- is-sham-link: boolean
-
If true, it is a sham link
- lsa-detail: OSPFV3-EDM-DB-DETAIL
-
Detailed LSA information
- virtual-link-id: integer
-
Virtual link ID
- prefix: string
-
OSPFv3 address Prefix
- reference-type: integer
-
Reference type
- router-la-bits: integer
-
Router LA bits
- sham-link-id: integer
-
Sham link ID
Example
{
"lsa-router-id": "integer",
"prefix-length": "integer",
"interface-name": "string",
"links": "integer",
"is-virtual-link": "boolean",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"reference-lsa-id": "integer",
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"prefix": "string",
"reference-type": "integer",
"router-la-bits": "integer",
"sham-link-id": "integer"
}
OSPFV3-SH-IPFRR-TOPO:
OSPF IPFRR Topology Information
- ipfrr-router-id: string
-
OSPF Router ID
- ipfrr-area-revision: integer
-
IPFRR Topology Revision
- ipfrr-topo: OSPF-SH-IPFRR-TOPO-ENTRY
-
IPFRR Topology entries
- ipfrr-topo-area-id: string
-
Area ID string in decimal or dotted decimal format
Example
{
"ipfrr-router-id": "string",
"ipfrr-area-revision": "integer",
"ipfrr-topo": [
{
"distance": "integer",
"neighbor-sourced": "boolean",
"lsaid": "integer",
"type4": "boolean",
"dr": "boolean",
"node-id": "string",
"revision": "integer"
}
],
"ipfrr-topo-area-id": "string"
}
OSPFV3-EDM-SPF-STATS:
OSPFv3 SPF statistics
- spf-runtime: OSPFV3-RUNTIME-STATS
-
List of SPF run-time statistics
- spf-header: OSPFV3-HEADER-INFO
-
SPF statistics header
Example
{
"spf-runtime": [
{
"rib-delete-routes": "integer",
"start-time": "integer",
"global-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"lsa": [
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
],
"lsa-changes": "string",
"reason-flags": "string",
"area-stat": [
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
],
"rib-add-routes": "integer"
}
],
"spf-header": {
"area-summary": [
{
"sp-fs": "integer",
"area-id": "integer"
}
],
"header-sp-fs": "integer",
"header-router-id": "string"
}
}
OSPFV3-EDM-BATCH-STATS:
OSPFv3 RIB batch statistics
- batches-sent: integer
-
No. of RIB batches sent
- paths-add-errs: integer
-
No. of paths add errors
- paths-add: integer
-
No. of paths added to RIB
- routes-pending: integer
-
No of Pending Routes
- paths-pending: integer
-
No. of paths waiting to be sent to RIB
- paths-sent: integer
-
No. of Paths sent to RIB
- routes-sent: integer
-
No. of Routes sent to RIB
- max-routes: integer
-
Max No. of Routes in a batch
- paths-del-errs: integer
-
No. of Paths del errors
- paths-del: integer
-
No. of paths del sent to RIB
Example
{
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
NEIGHBOR-DETAIL-PROCESS-TABLE:
Common node of default-vrf, vrf
- neighbor-detail-process-table: NEIGHBOR-DETAIL
-
OSPFv3 neighbor information table for all areas
Example
{
"neighbor-detail-process-table": {
"neighbor-detail": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
}
OSPF-SH-IPFRR-TB:
OSPF IPFRR Tiebreakers
- tiebreaker-type: string downstream, line-card-disjoint, backup-metric, node-protect, primary-path, secondary-path, srlg-disjoint, tunnel
-
Tiebreaker Type
- tiebreaker-index: integer
-
Tiebreaker Index
Example
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
OSPFV3-EDM-RPF-PATH:
OSPFv3 Router LSA Reverse-Path Forwarding Information
- rpf-multicast-next-hop: integer
-
RPF multicast next hop
- interface-name: string
-
RPF multicast IDB
Example
{
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
NSR-PL-CLIENT-STATS-TYPE:
NSR PL stats information
- num-recv-drop: NSR-PL-RECV-DROP-ARRAY
-
Recv Errors/drops
- num-recv: integer[]
- num-sent: integer[]
- num-sent-drop: NSR-PL-SEND-DROP-ARRAY
-
Sent Error/drops
Example
{
"num-recv-drop": [
{
"nsr-pl-recv-drop-array": [
"integer"
]
}
],
"num-recv": [
"integer"
],
"num-sent": [
"integer"
],
"num-sent-drop": [
{
"nsr-pl-send-drop-array": [
"integer"
]
}
]
}
OSPFV3-SPF-TIME:
OSPFv3 SPF Time Information
- rib-del: integer
-
RIB deletion time in msec
- external-prefix-del: integer
-
External prefix deletion time in msec
- rib-add: integer
-
RIB add processing time in msec
- inter-prefix-del: integer
-
Intra-prefix deletion time in msec
- intra-prefix: integer
-
Intra-prefix processing time in msec
- inter-prefix: integer
-
Inter-prefix processing time in msec
- intra-prefix-del: integer
-
Intra-prefix deletion time in msec
- dijkstra: integer
-
Dijkstra time in msec
- external-prefix: integer
-
External prefix processing time in msec
Example
{
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
}
OSPFV3-EDM-PROTO-AREA:
OSPFv3 Protocol Area Information
- protocol-interface: OSPFV3-EDM-PROTO-INTF
-
Interface list
- distribute-list-in: string
-
Distribute List In
- protocol-area-id: string
-
Area ID string in decimal and dotted-decimal format
Example
{
"protocol-interface": [
{
"distribute-list-in": "string",
"interface-name": "string"
}
],
"distribute-list-in": "string",
"protocol-area-id": "string"
}
ROUTE-SUMMARY:
Common node of default-vrf, vrf
- route-summary: OSPFV3-EDM-ROUTE-SUM
-
Summarize OSPFv3 local RIB tables
Example
{
"route-summary": {
"total-sent-route": "integer",
"inter-area-route": "integer",
"nssa-two-route": "integer",
"extern-two-route": "integer",
"route-connected": "integer",
"redistribution-route": "integer",
"intra-area-route": "integer",
"nssa-one-route": "integer",
"extern-one-route": "integer",
"total-received-route": "integer",
"route-id": "string"
}
}
OSPFV3-SH-SLINK-NEIGHBOR:
Sham Link Neighbor Information
- sham-link-state: string neigbhor-down, attempt, init, two-way, exstart, exchange, loading, full, sc-virtual
-
Adjacency state
- sham-link-suppress-hello: boolean
-
If true Hellos suppressed
- sham-link-retransmission: OSPFV3-EDM-NEIGHBOR-RETRANS
-
Neighbor retransmission info
Example
{
"sham-link-state": "string",
"sham-link-suppress-hello": "boolean",
"sham-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
}
OSPF-SH-IPFRR-TOPO-ENTRY:
OSPF_IPFRR Topology Entry
- distance: integer
-
IPFRR Topology Distance
- neighbor-sourced: boolean
-
IPFRR Topology Neighbor Sourced
- lsaid: integer
-
IPFRR Topology LSA ID
- type4: boolean
-
IPFRR Topoogy Type-4 entry
- dr: boolean
-
IPFRR Topology DR entry
- node-id: string
-
IPFRR Topology Node ID
- revision: integer
-
IPFRR Topology Revision
Example
{
"distance": "integer",
"neighbor-sourced": "boolean",
"lsaid": "integer",
"type4": "boolean",
"dr": "boolean",
"node-id": "string",
"revision": "integer"
}
DATABASE-TABLE:
Common node of area, default-vrf, vrf
- database-table: object
-
OSPF Link State Database
Example
{
"database-table": {
"lsa-table": {
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer"
}
}
}
}
]
}
}
}
REQUEST-LIST:
Common node of request-list-process-table, request-list-table
- request: object[]
-
OSPFv3 request list information
Example
{
"request": [
{
"neighbor-address": "string",
"interface-name": "string",
"request-virtual-link-id": "integer",
"request": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"request-neighbor-address": "string",
"request-sham-link-id": "integer",
"is-request-sham-link": "boolean",
"is-request-virtual-link": "boolean"
}
]
}
OSPFV3-EDM-LSA-SUM:
LSA summary entry
- header-lsa-age: integer
-
Age of the LSA (seconds)
- header-sequence-number: string
-
Current LSA sequence number
- header-advertising-router: string
-
Router ID of the advertising router
- header-lsa-type: string link, grace, router, network, inter-area-prefix, inter-area-router, mospf, type7-external, lsa-prefix, as-external, unknown-link, unknown-area, unknown-as, unknown-type
-
LSA type
- header-lsa-id: string
-
LSA ID
Example
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
OSPFV3-EDM-DB-SUMMARY-COUNTERS:
OSPFv3 Database Summary Counters
- lsa-checksum: integer[]
- deleted-lsa: integer[]
- max-age-lsa: integer[]
- lsa: integer[]
Example
{
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
OSPFV3-EDM-DB-SUMMARY:
OSPFv3 Database Summary
- area-database: OSPFV3-EDM-DB-SUMMARY-AREA
-
OSPFv3 Area Database list
- is-opaque-database-capable: boolean
-
If true, opaque database is capable
- database-router-id: string
-
Database router ID
- database-counters: OSPFV3-EDM-DB-SUMMARY-COUNTERS
-
OSPFv3 database counters
Example
{
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
RETRANSMISSION-LIST-PROCESS-TABLE:
Common node of default-vrf, vrf
- retransmission-list-process-table: RETRANSMISSION-LIST
-
OSPFv3 retransmission list information table for all areas
Example
{
"retransmission-list-process-table": {
"retransmission": [
{
"neighbor-address": "string",
"interface-name": "string",
"retransmission-area-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-asdb": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-timer": "integer",
"is-retransmissionvirtual-link": "boolean",
"retransmission-length": "integer",
"is-retransmission-sham-link": "boolean",
"retransmissionvirtual-link-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-neighbor-address": "string",
"retransmission-sham-link-id": "integer",
"retransmissionvirtual-link-id": "integer"
}
]
}
}
SHAM-LINK-TABLE:
Common node of default-vrf, vrf
- sham-link-table: OSPFV3-SH-SHAM-LINKS
-
Sham link information
Example
{
"sham-link-table": {
"virtual-link-authentication-spi": "integer",
"is-sham-link-ip-security-active": "boolean",
"sham-link-last-gr": "integer",
"sham-link-retransmission-interval": "integer",
"sham-link-area": "string",
"is-sham-link-ip-security-required": "boolean",
"sham-link-demand-circuit": "boolean",
"sham-link-ifindex": "integer",
"sham-link-encryption-transmitted": "integer",
"sham-link-authentication-transmit": "integer",
"sham-link-neighbor": {
"sham-link-state": "string",
"sham-link-suppress-hello": "boolean",
"sham-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
},
"sham-link-dest-address": "string",
"sham-link-dc-bitless-lsa": "integer",
"sham-link-encryption-spi": "integer",
"sham-link-dead-interval": "integer",
"sham-link-wait-interval": "integer",
"is-sham-link-authentication-enabled": "boolean",
"sham-link-neighbor-id": "string",
"sham-link-next-hello": "integer",
"sham-link-gr-enabled": "boolean",
"sham-link-transmission-delay": "integer",
"sham-link-cost": "integer",
"sham-link-gr": "boolean",
"sham-link-passive": "boolean",
"sham-link-encrypted-authentication-transmitted": "integer",
"is-sham-link-encryption-enabled": "boolean",
"sham-link-hello-interval": "integer",
"sham-link-state": "string",
"sham-link-source-address": "string"
}
}
OSPFV3-LSA-CHANGE:
OSPFv3 LSA Change Information
- lsa-flush: boolean
-
If true, the LSA change is a flush
- lsa-type: integer
-
LSA type
- lsa-advertising-router: string
-
Advertising router ID
- lsa-id: string
-
LSA ID
- lsa-area-id: integer
-
Area ID
Example
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
OSPF-SH-NCD-STATS:
OSPF SH NCD STATS
- ncd-pri: NSR-PL-CLIENT-STATS-TYPE
-
ncd pri
Example
{
"ncd-pri": [
{
"num-recv-drop": [
{
"nsr-pl-recv-drop-array": [
"integer"
]
}
],
"num-recv": [
"integer"
],
"num-sent": [
"integer"
],
"num-sent-drop": [
{
"nsr-pl-send-drop-array": [
"integer"
]
}
]
}
]
}
OSPFV3-ISSU-MILESTONE-BAG:
OSPFV3 ISSU MILESTONE BAG
- milestone-name: string
-
Milestone Name
- milestone-status: string
-
Milestone Status
Example
{
"milestone-name": "string",
"milestone-status": "string"
}
OSPFV3-EDM-LINK:
OSPFv3 Router LSA Links
- link-neighbor-router-id: integer
-
LSA link neigbhor router id
- link-metric: integer
-
LSA link metric
- link-neighbor-interface-id: integer
-
LSA link neighbor interface ID
- link-type: string link-router, link-trans-net, link-virtual-link
-
Type of link
- link-interface-id: integer
-
LSA link interface ID
Example
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
INTERFACE-PROCESS-TABLE:
Common node of default-vrf, vrf
- interface-process-table: INTERFACE
-
OSPFv3 interface information table for all areas
Example
{
"interface-process-table": {
"interface": [
{
"interface-name": "string",
"dead-interval": "integer",
"interface-bfd": {
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
},
"interface-encrypted-authentication-transmitted": "integer",
"network-type": "string",
"is-interface-encryption-enabled": "boolean",
"interface-references": "integer",
"backup-designated-router-address": "string",
"is-interface-ip-security-active": "boolean",
"interface-link-cost": "integer",
"interface-address": "string",
"adjacent-neighbor": "integer",
"configured-ldp-sync": "boolean",
"interface-number": "integer",
"designated-router-address": "string",
"transmission-delay": "integer",
"interface-router-id": "string",
"interface-ldp-sync": "boolean",
"interface-dc-bitless-ls-as": "integer",
"ospf-interface-state": "string",
"designated-router-id": "string",
"is-prefix-suppress": "boolean",
"is-interface-lsa-filtered": "boolean",
"hello-interval": "integer",
"next-hello-time": "integer",
"interface-neighbor": [
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
],
"network-lsa-flush-timer": "integer",
"is-interface-demand-circuit": "boolean",
"interface-encryption-transmitted": "integer",
"interface-state": "string",
"wait-interval": "integer",
"is-designated-router": "boolean",
"active-interface": {
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
},
"backup-designated-router-id": "string",
"is-interface-flood-reduction": "boolean",
"is-demand-circuit-configured": "boolean",
"interface-retransmission-interval": "integer",
"interface-authentication-spi": "integer",
"interface-encryption-spi": "integer",
"interface-authentication-transmit": "integer",
"interface-priority": "integer",
"is-interface-line-up": "boolean",
"is-interface-ip-security-required": "boolean"
}
]
}
}
OSPFV3-EDM-RTHREAD-QUEUE-STATS:
OSPFv3 RIB thread queue statistics
- wq-len-max: string
-
Largest Work Queue Length
- wq-total-dequeued: integer
-
Total Entries Dequeued
- wq-sum-latency: integer
-
Sum Latencies To Calc Average
- wq-first-eqtime: integer
-
First Entry Enqueue
- wq-dequeue-errs: integer
-
Dequeue Errors
- wq-total-enqueued: integer
-
Total Entries Enqueued
- wq-len-cur: string
-
Current Work Queue Length
- wq-dqtime: integer
-
Last Entry Dequeue
- wq-eqtime: integer
-
Head Entry Enqueue
- wq-max-latency: integer
-
Max Time Entry Was In Q
- wq-eneueue-errs: integer
-
Enqueue Errors
Example
{
"wq-len-max": "string",
"wq-total-dequeued": "integer",
"wq-sum-latency": "integer",
"wq-first-eqtime": "integer",
"wq-dequeue-errs": "integer",
"wq-total-enqueued": "integer",
"wq-len-cur": "string",
"wq-dqtime": "integer",
"wq-eqtime": "integer",
"wq-max-latency": "integer",
"wq-eneueue-errs": "integer"
}
FLOOD-LIST-PROCESS-TABLE:
Common node of default-vrf, vrf
- flood-list-process-table: FLOOD-LIST
-
OSPFv3 flood list information table for all areas
Example
{
"flood-list-process-table": {
"flood": [
{
"interface-name": "string",
"queue-length": "integer",
"as-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"area-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"ls-transmission-timer": "integer",
"link-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
]
}
]
}
}
OSPFV3-EDM-TOPOLOGY-CONNECTED:
OSPFv3 Topology Connected Information
- route-topology: OSPFV3-EDM-TOPOLOGY
-
Common Route topology information
- route-path: OSPFV3-EDM-TOP-PATH
-
List of paths to this route
Example
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
INTERFACE-BRIEF:
Common node of interface-brief-table, interface-brief-process-table
- interface-brief: object[]
-
Interface brief information
Example
{
"interface-brief": [
{
"interface-name": "string",
"interface-neighbors": "integer",
"interface-link-cost": "integer",
"interface-adjacent-neighbors": "integer",
"interface-address": "string",
"network-type": "string",
"ospf-interface-state": "string"
}
]
}
SUMMARY-PREFIX-TABLE:
Common node of default-vrf, vrf
- summary-prefixes: object
-
Summary prefix information table
Example
{
"summary-prefixes": {
"summary-prefix": [
{
"prefix": "string",
"prefix-length": "string",
"prefix-metric": "integer",
"prefix-metric-type": "string",
"tag": "integer"
}
]
}
}
CONNECTED-ROUTE-TABLE:
Common node of default-vrf, vrf
- connected-routes: object
-
OSPFv3 connected route information table
Example
{
"connected-routes": {
"connected-route": [
{
"prefix": "string",
"prefix-length": "string",
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
]
}
}
OSPFV3-EDM-LSA-PREFIX:
OSPFv3 Prefix LSA
- reference-lsa-id: integer
-
Reference LSA ID
- lsa-detail: OSPFV3-EDM-DB-DETAIL
-
Detailed LSA information
- reference-advertised-router: string
-
Reference advertised router
- prefix: OSPFV3-EDM-PREFIX
-
OSPFv3 prefix
- reference-type: string link, grace, router, network, inter-area-prefix, inter-area-router, mospf, type7-external, lsa-prefix, as-external, unknown-link, unknown-area, unknown-as, unknown-type
-
Reference type
- lsa-header: OSPFV3-EDM-DB-HEADER
-
Header information
Example
{
"reference-lsa-id": "integer",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"reference-advertised-router": "string",
"prefix": [
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
],
"reference-type": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
PROTOCOL-AREA-TABLE:
Common node of default-vrf, vrf
- protocol-areas: object
-
Protocol area table
Example
{
"protocol-areas": {
"protocol-area": [
{
"area-id": "string",
"protocol-interface": [
{
"distribute-list-in": "string",
"interface-name": "string"
}
],
"distribute-list-in": "string",
"protocol-area-id": "string"
}
]
}
}
OSPFV3-EDM-VLINK-NEIGHBOR:
OSPFv3 virtual link neighbor information
- virtual-link-state: string down, loopback, waiting, point-to-multipoint, point-to-point, designated-router, backup-designated-router, other-designated-router
-
OSPF interface state for the virtual link
- is-virtual-link-hello-suppressed: boolean
-
If true, hello suppressed
- virtual-link-retransmission: OSPFV3-EDM-NEIGHBOR-RETRANS
-
Virtual link retransmission information
Example
{
"virtual-link-state": "string",
"is-virtual-link-hello-suppressed": "boolean",
"virtual-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
}
OSPFV3-EDM-RETRANS:
OSPFv3 retransmission list information
- retransmission-area-db: OSPFV3-EDM-LSA-SUM
-
List of area scope entries
- retransmission-asdb: OSPFV3-EDM-LSA-SUM
-
List of AS scope entries
- retransmission-timer: integer
-
Amount of time remaining on retransmission timer (ms)
- is-retransmissionvirtual-link: boolean
-
If true, virtual link is retransmitted
- retransmission-length: integer
-
Retransmission queue length
- is-retransmission-sham-link: boolean
-
If true, sham link is retransmitted
- retransmissionvirtual-link-db: OSPFV3-EDM-LSA-SUM
-
List of virtual link scope entries
- retransmission-neighbor-address: string
-
Neighbor IP address
- retransmission-sham-link-id: integer
-
Retransmission sham link ID
- retransmissionvirtual-link-id: integer
-
Retransmission virtual link ID
Example
{
"retransmission-area-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-asdb": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-timer": "integer",
"is-retransmissionvirtual-link": "boolean",
"retransmission-length": "integer",
"is-retransmission-sham-link": "boolean",
"retransmissionvirtual-link-db": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"retransmission-neighbor-address": "string",
"retransmission-sham-link-id": "integer",
"retransmissionvirtual-link-id": "integer"
}
OSPFV3-EDM-INTERFACE-BFD:
Interface BFD information
- bfd-intf-enable-mode: integer
-
BFD Enable Mode on the interface - Default/Strict
- bfd-detection-multiplier: integer
-
BFD detection multiplier
- bfd-interval: integer
-
BFD interval (ms)
Example
{
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
}
OSPFV3-EDM-LSA-ROUTER:
OSPFv3 Router LSA
- link: OSPFV3-EDM-LINK
-
List of links in this LSA
- lsa-detail: OSPFV3-EDM-DB-DETAIL
-
Detailed LSA information
- router-la-bits: integer
-
Router LA bits
- lsa-header: OSPFV3-EDM-DB-HEADER
-
Header information
- rpf-path: OSPFV3-EDM-RPF-PATH
-
Router LSA Reverse-Path Forwarding information
Example
{
"link": [
{
"link-neighbor-router-id": "integer",
"link-metric": "integer",
"link-neighbor-interface-id": "integer",
"link-type": "string",
"link-interface-id": "integer"
}
],
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"router-la-bits": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"rpf-path": {
"rpf-multicast-next-hop": "integer",
"interface-name": "string"
}
}
OSPFV3-EDM-DB-HEADER:
OSPFv3 LSA Database Header
- lsa-type: integer
-
LSA type
- sequence-number: integer
-
Current Sequence number
- lsa-age: integer
-
LSA's Age (s)
- checksum: integer
-
Checksum value
- is-do-not-age-lsa: boolean
-
If true, Do Not Age this LSA
- advertising-router: string
-
Router ID of Advertising Router
- ls-id: integer
-
LS ID
- is-graceful-restart-active: boolean
-
If true, if grace restart is active
- lsa-area-id: string
-
Area ID in decimal or dotted-decimal format
Example
{
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
OSPFV3-EDM-PROTO-INTF:
OSPFv3 Protocol Interface Information
- distribute-list-in: string
-
Distribute List In
- interface-name: string
-
Protocol interface name
Example
{
"distribute-list-in": "string",
"interface-name": "string"
}
OSPFV3-EDM-ROUTE-SUM:
OSPFv3 route summary information
- total-sent-route: integer
-
Total route summary
- inter-area-route: integer
-
Inter route summary
- nssa-two-route: integer
-
NSSA 2 route summary
- extern-two-route: integer
-
Extern 2 route summary
- route-connected: integer
-
Route connected
- redistribution-route: integer
-
Redistribution route summary
- intra-area-route: integer
-
Intra route summary
- nssa-one-route: integer
-
NSSA 1 route summary
- extern-one-route: integer
-
Extern 1 route summary
- total-received-route: integer
-
Total route received summary
- route-id: string
-
Route summary of a route ID
Example
{
"total-sent-route": "integer",
"inter-area-route": "integer",
"nssa-two-route": "integer",
"extern-two-route": "integer",
"route-connected": "integer",
"redistribution-route": "integer",
"intra-area-route": "integer",
"nssa-one-route": "integer",
"extern-one-route": "integer",
"total-received-route": "integer",
"route-id": "string"
}
OSPFV3-HEADER-INFO:
OSPFv3 SPF Statistics Header Information
- area-summary: OSPFV3-EDM-AREA-SUMM
-
List of Areas with SPF statistics
- header-sp-fs: integer
-
Number of SPF calculations
- header-router-id: string
-
Router ID
Example
{
"area-summary": [
{
"sp-fs": "integer",
"area-id": "integer"
}
],
"header-sp-fs": "integer",
"header-router-id": "string"
}
OSPFV3-SH-BAD-CHECKSUM:
OSPFv3 Bad Checksum
- timestamp: OSPFV3-EDM-TIME
-
Packet Timestamp (relative to 1970/1/1 00:00)
- computed-checksum: integer
-
Computed Checksum
- received-data: string
-
Received Hexadecimal Data
- received-checksum: integer
-
Received Checksum
Example
{
"timestamp": {
"second": "integer",
"nanosecond": "integer"
},
"computed-checksum": "integer",
"received-data": "string",
"received-checksum": "integer"
}
OSPFV3-EDM-FLOOD-LIST:
OSPFv3 flood list information
- queue-length: integer
-
Number of LSAs currently being flooded
- as-flood: OSPFV3-EDM-LSA-SUM
-
AS scope floodlist
- area-flood: OSPFV3-EDM-LSA-SUM
-
Area scope floodlist
- ls-transmission-timer: integer
-
Time until next LS transmission (ms)
- link-flood: OSPFV3-EDM-LSA-SUM
-
Link floodlist
Example
{
"queue-length": "integer",
"as-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"area-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"ls-transmission-timer": "integer",
"link-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
]
}
OSPFV3-LSA-INFO-UNION:
Detail LSA information for an LSA
- nssalsa-type: OSPFV3-EDM-LSA-EXTERNAL
-
NSSA External LSA
- unknown-lsa-type: OSPFV3-EDM-LSA-UNKNOWN
-
Unknown LSA
- grace-lsa: OSPFV3-EDM-LSA-GRACE
-
Grace LSA
- lsa-info-type: string mgmt-lsa-lsasum-type, mgmt-lsa-link-type, mgmt-lsa-gr-type, mgmt-lsa-rtr-type, mgmt-lsa-net-type, mgmt-lsa-iapfx-type, mgmt-lsa-iartr-type, mgmt-lsa-nssaext-type, mgmt-lsa-prefix-type, mgmt-lsa-ext-type, mgmt-lsa-unk-link-type, mgmt-lsa-unk-area-type, mgmt-lsa-unk-as-type, mgmt-lsa-unk-type
-
LSAInfoType
- network-lsa-type: OSPFV3-EDM-LSA-NETWORK
-
Network LSA
- unknown-aslsa-type: OSPFV3-EDM-LSA-UNKNOWN
-
Unknown-AS scope LSA
- inter-area-prefix-lsa-type: OSPFV3-EDM-LSA-IAPFX
-
Inter Area Prefix LSA
- link-lsa-type: OSPFV3-EDM-LSA-LINK
-
Link LSA
- unknown-link-lsa-type: OSPFV3-EDM-LSA-UNKNOWN
-
Unknown Link Scope LSA
- lsa-summary-info: OSPFV3-EDM-DATABASE
-
Summary information of LSAs
- router-lsa-type: OSPFV3-EDM-LSA-ROUTER
-
Router LSA
- inter-area-router-lsa-type: OSPFV3-EDM-LSA-IARTR
-
Inter Area Router LSA
- unknown-area-lsa-type: OSPFV3-EDM-LSA-UNKNOWN
-
Unknown-Area scope LSA
- intra-area-prefix-lsa-type: OSPFV3-EDM-LSA-PREFIX
-
Intra Area Prefix LSA
- external-lsa-type: OSPFV3-EDM-LSA-EXTERNAL
-
External LSA
Example
{
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {}
}
}
OSPFV3-EDM-INTERFACE:
OSPFv3 interface information
- dead-interval: integer
-
Configured dead interval (s)
- interface-bfd: OSPFV3-EDM-INTERFACE-BFD
-
BFD information
- interface-encrypted-authentication-transmitted: integer
-
Interface encrypted authentication transmitted
- network-type: string none, broadcast, non-broadcast, point-to-point, point-to-multipoint, point-to-multipoint-non-broadcast, virtual-link, loopback-interface, mpls-traffic-engineering, sham-link
-
Network type
- is-interface-encryption-enabled: boolean
-
If true, interface encryption is enabled
- interface-references: integer
-
Interface reference count
- backup-designated-router-address: string
-
Backup designated router interface address
- is-interface-ip-security-active: boolean
-
If true, interface IP security is active
- interface-link-cost: integer
-
Interface link cost
- interface-address: string
-
Interface IPv6 address
- adjacent-neighbor: integer
-
Number of adjacent neighbors
- configured-ldp-sync: boolean
-
If true, configured as LDP sync
- interface-number: integer
-
Interface number
- designated-router-address: string
-
Designated router interface address
- transmission-delay: integer
-
Interface transmission delay (sec)
- interface-router-id: string
-
Interface router ID
- interface-ldp-sync: boolean
-
If true, interface LDP sync is achieved
- interface-dc-bitless-ls-as: integer
-
Number of LSAs with demand circuit bit not set for the area in which the interface is running
- ospf-interface-state: string down, loopback, waiting, point-to-multipoint, point-to-point, designated-router, backup-designated-router, other-designated-router
-
Interface state
- designated-router-id: string
-
Designated router ID
- is-prefix-suppress: boolean
-
If true prefix suppression is enabled
- is-interface-lsa-filtered: boolean
-
Filter is configured for out going LSAs
- hello-interval: integer
-
Configured hello interval (s)
- next-hello-time: integer
-
Time until next Hello (s)
- interface-neighbor: OSPFV3-EDM-INTERFACE-NBR
-
Information for neighbors on the interface
- network-lsa-flush-timer: integer
-
The amount of time in seconds before flush timer for old network LSA expires
- is-interface-demand-circuit: boolean
-
If true, interface running as demand circuit
- interface-encryption-transmitted: integer
-
Interface encryption transmitted
- interface-state: string im-state-not-ready, im-state-admin-down, im-state-down, im-state-up, im-state-shutdown, im-state-err-disable, im-state-down-immediate, im-state-down-immediate-admin, im-state-down-graceful, im-state-begin-shutdown, im-state-end-shutdown, im-state-begin-error-disable, im-state-end-error-disable, im-state-begin-down-graceful, im-state-reset, im-state-operational, im-state-not-operational, im-state-unknown, im-state-last
-
Interface state
- wait-interval: integer
-
Configured wait interval (s)
- is-designated-router: boolean
-
If true, designated router
- active-interface: OSPFV3-EDM-INTERFACE-UP
-
Active interface details
- backup-designated-router-id: string
-
Backup designated router ID
- is-interface-flood-reduction: boolean
-
If true, interface flood reduction is active
- is-demand-circuit-configured: boolean
-
If true, configured as demand circuit
- interface-retransmission-interval: integer
-
Configured retransmit interval (s)
- interface-authentication-spi: integer
-
Interface authentication spi
- interface-encryption-spi: integer
-
Interface encryption spi
- interface-authentication-transmit: integer
-
Interface authentication transmit
- interface-priority: integer
-
Interface priority
- is-interface-line-up: boolean
-
If true, line protocol is up
- is-interface-ip-security-required: boolean
-
If true, interface IP security is required
Example
{
"dead-interval": "integer",
"interface-bfd": {
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
},
"interface-encrypted-authentication-transmitted": "integer",
"network-type": "string",
"is-interface-encryption-enabled": "boolean",
"interface-references": "integer",
"backup-designated-router-address": "string",
"is-interface-ip-security-active": "boolean",
"interface-link-cost": "integer",
"interface-address": "string",
"adjacent-neighbor": "integer",
"configured-ldp-sync": "boolean",
"interface-number": "integer",
"designated-router-address": "string",
"transmission-delay": "integer",
"interface-router-id": "string",
"interface-ldp-sync": "boolean",
"interface-dc-bitless-ls-as": "integer",
"ospf-interface-state": "string",
"designated-router-id": "string",
"is-prefix-suppress": "boolean",
"is-interface-lsa-filtered": "boolean",
"hello-interval": "integer",
"next-hello-time": "integer",
"interface-neighbor": [
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
],
"network-lsa-flush-timer": "integer",
"is-interface-demand-circuit": "boolean",
"interface-encryption-transmitted": "integer",
"interface-state": "string",
"wait-interval": "integer",
"is-designated-router": "boolean",
"active-interface": {
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
},
"backup-designated-router-id": "string",
"is-interface-flood-reduction": "boolean",
"is-demand-circuit-configured": "boolean",
"interface-retransmission-interval": "integer",
"interface-authentication-spi": "integer",
"interface-encryption-spi": "integer",
"interface-authentication-transmit": "integer",
"interface-priority": "integer",
"is-interface-line-up": "boolean",
"is-interface-ip-security-required": "boolean"
}
OSPFV3-EDM-PRIO-STATS:
OSPFv3 SPF prefix priority classification statistics
- high: integer
-
High priority classifications
- medium: integer
-
Medium priority classifications
- critical: integer
-
Critical priority classifications
- low: integer
-
Low priority classifications
Example
{
"high": "integer",
"medium": "integer",
"critical": "integer",
"low": "integer"
}
OSPFV3-SH-DOMAIN-ID-ENTRY:
OSPF Domain ID
- domain-id-type: integer
-
Domain ID Type
- domain-id-value: string
-
Domain ID value
Example
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
OSPFV3-EDM-REDIST:
OSPFv3 Redistribution Information
- red-metric: integer
-
red metric
- policy-name: string
-
Route policy name
- red-tag: integer
-
red tag
- red-metric-type: integer
-
red metric type
- red-metric-flag: boolean
-
red metric flag
- red-mtype-flag: boolean
-
red mtype flag
- process-id: string
-
Process ID
- protocol-name-xr: string
-
Protocol name
Example
{
"red-metric": "integer",
"policy-name": "string",
"red-tag": "integer",
"red-metric-type": "integer",
"red-metric-flag": "boolean",
"red-mtype-flag": "boolean",
"process-id": "string",
"protocol-name-xr": "string"
}
OSPFV3-EDM-AREA:
OSPFv3 area summary information
- is-area-stubbed: boolean
-
If true, stub area
- is-rrr-enabled: boolean
-
If true, RRR is enabled
- area-lfa-revision: integer
-
Area LFA revision
- is-nssa-translated: boolean
-
If true, perform 7/5 translation
- indication-ls-as: integer
-
Number of indication LSAs
- is-area-nssa: boolean
-
If true, area is a NSSA
- is-backbone-area-active: boolean
-
If true, Backbone area is active
- area-lfa-interface-count: integer
-
Number of LFA enabled interfaces
- area-interfaces: integer
-
Number of interfaces in the area
- is-area-total-stubbed: boolean
-
If true, totally stubby area
- area-opaque-lsas: integer
-
Number of opaque LSAs in the area
- is-nssa-translated-always: boolean
-
If true, perform 7/5 translation always
- flood-list-length: integer
-
Number of LSAs which need to be flooded
- stub-default-cost: integer
-
Default cost for Stub or NSSA area
- is-nssa-default: boolean
-
If true, generate NSSA default route
- sp-fs: integer
-
Number of SPF calculations run
- area-per-prefix-lfa-interface-count: integer
-
Number of Per Prefix LFA enabled interfaces
- area-opaque-lsa-checksum: integer
-
Sum of opaque LSA checksums
- nssa-no-redistribution: boolean
-
If true, No redistribution into this NSSA area
- area-range: OSPFV3-EDM-AREA-RANGE
-
List of ranges to summarize
- area-dc-bitless-ls-as: integer
-
Number of LSA with demand circuit bit not set
- do-not-age-ls-as: integer
-
Number of do not age LSAs
Example
{
"is-area-stubbed": "boolean",
"is-rrr-enabled": "boolean",
"area-lfa-revision": "integer",
"is-nssa-translated": "boolean",
"indication-ls-as": "integer",
"is-area-nssa": "boolean",
"is-backbone-area-active": "boolean",
"area-lfa-interface-count": "integer",
"area-interfaces": "integer",
"is-area-total-stubbed": "boolean",
"area-opaque-lsas": "integer",
"is-nssa-translated-always": "boolean",
"flood-list-length": "integer",
"stub-default-cost": "integer",
"is-nssa-default": "boolean",
"sp-fs": "integer",
"area-per-prefix-lfa-interface-count": "integer",
"area-opaque-lsa-checksum": "integer",
"nssa-no-redistribution": "boolean",
"area-range": [
{
"range-prefix": "string",
"net-cost": "integer",
"range-prefix-length": "integer",
"status": "string",
"is-cost-configured": "boolean"
}
],
"area-dc-bitless-ls-as": "integer",
"do-not-age-ls-as": "integer"
}
OSPFV3-EDM-TOPOLOGY-EXTERNAL:
OSPFv3 Topology External Information
- route-topology: OSPFV3-EDM-TOPOLOGY
-
Common Route topology information
- route-extended-community: OSPFV3-SH-ROUTE-EXTENDED-COMM
-
Extended communities in the route
- route-path: OSPFV3-EDM-TOP-PATH
-
List of paths to this route
Example
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-extended-community": {
"extended-community-domain-id-value": "string",
"extended-community-area-id": "integer",
"extended-community-router-id": "string",
"extended-community-route-type": "integer",
"extended-community-options": "integer",
"extended-communityl-domain-id-type": "integer"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
OSPFV3-EDM-AREA-RANGE:
OSPFv3 area range information
- range-prefix: string
-
IP prefix for summarization
- net-cost: integer
-
Net cost
- range-prefix-length: integer
-
IP prefix length for summarization
- status: string advertise, do-not-advertise
-
Area range status
- is-cost-configured: boolean
-
If true, cost is configured
Example
{
"range-prefix": "string",
"net-cost": "integer",
"range-prefix-length": "integer",
"status": "string",
"is-cost-configured": "boolean"
}
FAST-REROUTE-TABLE:
Common node of default-vrf, vrf
- fast-reroutes: object
-
OSPFv3 fast reroute topology information table
Example
{
"fast-reroutes": {
"fast-reroute": [
{
"area-id": "integer",
"router-id": "string",
"ipfrr-router-id": "string",
"ipfrr-area-revision": "integer",
"ipfrr-topo": [
{
"distance": "integer",
"neighbor-sourced": "boolean",
"lsaid": "integer",
"type4": "boolean",
"dr": "boolean",
"node-id": "string",
"revision": "integer"
}
],
"ipfrr-topo-area-id": "string"
}
]
}
}
OSPFV3-SH-DOMAIN-ID:
OSPF Domain ID entries
- secondary-domain-id: OSPFV3-SH-DOMAIN-ID-ENTRY
-
List of secondary domain IDs
- primary-domain-id: OSPFV3-SH-DOMAIN-ID-ENTRY
-
Primary Domain ID
Example
{
"secondary-domain-id": [
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
],
"primary-domain-id": {
"domain-id-type": "integer",
"domain-id-value": "string"
}
}
OSPFV3-EDM-NSR-STATS:
OSPFV3 EDM NSR STATS
- nsr-lsa-qad-mdata-count: integer
-
LSA QAD pending msgs
- nsr-nbr-init-sync-pend-count: string
-
Pending init-sync NBR msgs
- nsr-mtu: integer
-
Fabric MTU
- nsr-nbr-qad-mdata-count: integer
-
NBR QAD pending msg
- nsr-conn-to-active-closes: integer
-
Conn to active closes
- nsr-conn-to-active-errors: integer
-
Conn to active errors
- nsr-nbr-seq-no: integer
-
Neighbor TLV sequence no
- nsr-conn-to-active-opens: integer
-
Conn to active opens
- nsr-issu-milestone: OSPFV3-ISSU-MILESTONE-BAG
-
Nsr Issu Milestones
- nsr-version: integer
-
NSR version
- nsr-intf-seq-no: integer
-
Interface TLV sequence no
- nsr-tmr-quant: string
-
Timers processed per pulse
- nsr-fsm-running-timer: string[]
- nsr-lsa-init-sync-pend-count: string
-
Pending init-sync LSA msgs
- nsr-peer-node-id: integer
-
Partner NodeID
- nsr-fsm-flag: string[]
- nsr-conn-to-active-attempts: integer
-
Attempts to connect to active
- nsr-conn-to-active-fails: integer
-
Failures to connect to active
- nsr-peer-version: integer
-
Partner NSR version
- nsr-thd-stats: OSPF-SH-NSR-SCHED-STATS
-
NSR thread scheduler stats
- nsr-rtr-thd-sched: OSPF-SH-NSR-SCHED-STATS
-
Rtr thread NSR pulse handler stats
- nsr-revision: string
-
NSR revision
- nsr-node-id: integer
-
My nodeid
- nsr-lsa-qad-qid: integer
-
LSA QAD queue id
- nsr-nbr-qad-qid: integer
-
NBR QAD queue id
- nsr-err-history: OSPFV3-NSR-ERR-BLOCK-BAG
-
Nsr Error History List
- nsr-fsm-state: string
-
FSM state
Example
{
"nsr-lsa-qad-mdata-count": "integer",
"nsr-nbr-init-sync-pend-count": "string",
"nsr-mtu": "integer",
"nsr-nbr-qad-mdata-count": "integer",
"nsr-conn-to-active-closes": "integer",
"nsr-conn-to-active-errors": "integer",
"nsr-nbr-seq-no": "integer",
"nsr-conn-to-active-opens": "integer",
"nsr-issu-milestone": [
{
"milestone-name": "string",
"milestone-status": "string"
}
],
"nsr-version": "integer",
"nsr-intf-seq-no": "integer",
"nsr-tmr-quant": "string",
"nsr-fsm-running-timer": [
"string"
],
"nsr-lsa-init-sync-pend-count": "string",
"nsr-peer-node-id": "integer",
"nsr-fsm-flag": [
"string"
],
"nsr-conn-to-active-attempts": "integer",
"nsr-conn-to-active-fails": "integer",
"nsr-peer-version": "integer",
"nsr-thd-stats": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-rtr-thd-sched": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-revision": "string",
"nsr-node-id": "integer",
"nsr-lsa-qad-qid": "integer",
"nsr-nbr-qad-qid": "integer",
"nsr-err-history": [
{
"nsr-error-info": [
{
"last-err-time": {
"second": "integer",
"nanosecond": "integer"
},
"err-info-string": "string",
"err-count": "string"
}
],
"nsr-revisionversion": "integer",
"total-errors": "string"
}
],
"nsr-fsm-state": "string"
}
OSPFV3-EDM-TIME:
OSPFv3 time stamp
- second: integer
-
Seconds
- nanosecond: integer
-
Nano seconds
Example
{
"second": "integer",
"nanosecond": "integer"
}
NSR-PL-RECV-DROP-ARRAY:
NSR PL RECV DROP ARRAY
- nsr-pl-recv-drop-array: integer[]
Example
{
"nsr-pl-recv-drop-array": [
"integer"
]
}
INTERFACE:
Common node of interface-table, interface-process-table
- interface: object[]
-
OSPFv3 interface information
Example
{
"interface": [
{
"interface-name": "string",
"dead-interval": "integer",
"interface-bfd": {
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
},
"interface-encrypted-authentication-transmitted": "integer",
"network-type": "string",
"is-interface-encryption-enabled": "boolean",
"interface-references": "integer",
"backup-designated-router-address": "string",
"is-interface-ip-security-active": "boolean",
"interface-link-cost": "integer",
"interface-address": "string",
"adjacent-neighbor": "integer",
"configured-ldp-sync": "boolean",
"interface-number": "integer",
"designated-router-address": "string",
"transmission-delay": "integer",
"interface-router-id": "string",
"interface-ldp-sync": "boolean",
"interface-dc-bitless-ls-as": "integer",
"ospf-interface-state": "string",
"designated-router-id": "string",
"is-prefix-suppress": "boolean",
"is-interface-lsa-filtered": "boolean",
"hello-interval": "integer",
"next-hello-time": "integer",
"interface-neighbor": [
{
"is-hello-suppressed": "boolean",
"interface-neighbor-id": "string",
"is-neighbor-dr": "boolean",
"interface-neighbor-cost": "integer",
"is-neighbor-bdr": "boolean"
}
],
"network-lsa-flush-timer": "integer",
"is-interface-demand-circuit": "boolean",
"interface-encryption-transmitted": "integer",
"interface-state": "string",
"wait-interval": "integer",
"is-designated-router": "boolean",
"active-interface": {
"interface-neighbors": "integer",
"suppressed-hellos": "integer",
"maximum-flood-length": "integer",
"interface-flood-pacing-timer": "integer",
"interface-link-next-index": "integer",
"interface-area-next-flood": "integer",
"last-flood-time": "integer",
"flood-queue-length": "integer",
"wait-time": "integer",
"interface-link-flood-index": "integer",
"interface-area-next-flood-index": "integer",
"interface-area-flood-index": "integer",
"interface-as-next-flood": "integer",
"interface-as-next-flood-index": "integer",
"interface-link-next-flood": "integer",
"maximum-flood-time": "integer",
"flood-scan-length": "integer",
"interface-as-flood-index": "integer"
},
"backup-designated-router-id": "string",
"is-interface-flood-reduction": "boolean",
"is-demand-circuit-configured": "boolean",
"interface-retransmission-interval": "integer",
"interface-authentication-spi": "integer",
"interface-encryption-spi": "integer",
"interface-authentication-transmit": "integer",
"interface-priority": "integer",
"is-interface-line-up": "boolean",
"is-interface-ip-security-required": "boolean"
}
]
}
PREFIX-PRIORITY-STATS:
Common node of statistics, vrf-statistics
- prefix-priority-stats: OSPFV3-EDM-PRIO-STATS
-
OSPF Prefix SPF Prioritization statistics
Example
{
"prefix-priority-stats": {
"high": "integer",
"medium": "integer",
"critical": "integer",
"low": "integer"
}
}
SUMMARY:
Common node of default-vrf, vrf
- summary: object
-
OSPFv3 summary
Example
{
"summary": {
"route": {
"total-sent-route": "integer",
"inter-area-route": "integer",
"nssa-two-route": "integer",
"extern-two-route": "integer",
"route-connected": "integer",
"redistribution-route": "integer",
"intra-area-route": "integer",
"nssa-one-route": "integer",
"extern-one-route": "integer",
"total-received-route": "integer",
"route-id": "string"
},
"protocol": {
"administrative-distance-inter-area": "integer",
"protocol-router-id": "string",
"is-graceful-restart": "boolean",
"administrative-distance": "integer",
"administrative-distance-external": "integer",
"distribute-list-in": "string"
},
"ospfv3": {
"is-nsr-enabled": "boolean",
"normal-areas": "integer",
"is-router-id-stalled": "boolean",
"last-nsf-time": "integer",
"lsa-hold-time": "integer",
"metric": "integer",
"is-grace-restart-enabled": "boolean",
"stub-areas": "integer",
"grace-resync-time": "integer",
"ipfrr-tiebreakers": [
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
],
"snmp-trap-enabled": "boolean",
"spf-start-time": "integer",
"default-metric": "integer",
"as-dc-bitless-ls-as": "integer",
"router-id": "string",
"spf-hold-time": "integer",
"context-name": "string",
"reference-bandwidth": "integer",
"as-lsa-flood-list-length": "integer",
"domain-id": {
"secondary-domain-id": [
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
],
"primary-domain-id": {
"domain-id-type": "integer",
"domain-id-value": "string"
}
},
"role": "integer",
"lsa-maximum-time": "integer",
"default-tag": "integer",
"is-default-originated": "boolean",
"is-opaque-capable": "boolean",
"opaque-lsas": "integer",
"is-nsr-switchover-on-restart": "boolean",
"is-area-border-router": "boolean",
"spf-maximum-time": "integer",
"maximum-paths": "integer",
"nssa-areas": "integer",
"lsa-retransmission-pacing-interval": "integer",
"default-metric-type": "string",
"minimum-lsa-interval": "integer",
"maximum-interfaces": "integer",
"redistribution-threshold": "integer",
"is-role-standby": "boolean",
"as-ls-as": "integer",
"lsa-group-interval": "integer",
"lsa-flood-pacing-interval": "integer",
"is-auto-cost": "boolean",
"redistribution-limit": "integer",
"areas": "integer",
"is-as-border-router": "boolean",
"opaque-lsa-checksum": "integer",
"stub-router": [
{
"remaining-time": "integer",
"include-stub-links": "boolean",
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"summary-lsa-metric": "integer",
"abr-off-reason": "string",
"external-lsa-metric": "integer"
}
]
}
}
}
OSPFV3-RUNTIME-STATS:
OSPFv3 SPF Runtime Statistics Information
- rib-delete-routes: integer
-
Number of routes deleted from RIB
- start-time: integer
-
SPF calculation start time
- global-time: OSPFV3-SPF-TIME
-
Global SPF times
- lsa: OSPFV3-LSA-CHANGE
-
List of LSAs triggering the SPF calculation
- lsa-changes: string
-
Number of LSA changes triggering an SPF calculation
- reason-flags: string
-
Reasons for triggering an SPF calculation Bit 1
- Router LSA update Bit 2 - Network LSA update Bit 3 - Inter-Area Prefix LSA update Bit 4 - Inter-Area Router LSA update Bit 5 - AS External LSA update Bit 6 - MOSPF LSA update Bit 7 - Type 7 AS External LSA update Bit 8 - Link LSA update Bit 9 - Prefix LSA update
- area-stat: OSPFV3-EDM-SPF-AREA-STATS
-
List of per-area SPF statistics
- rib-add-routes: integer
-
Number of routes added to RIB
Example
{
"rib-delete-routes": "integer",
"start-time": "integer",
"global-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"lsa": [
{
"lsa-flush": "boolean",
"lsa-type": "integer",
"lsa-advertising-router": "string",
"lsa-id": "string",
"lsa-area-id": "integer"
}
],
"lsa-changes": "string",
"reason-flags": "string",
"area-stat": [
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
],
"rib-add-routes": "integer"
}
INTERNAL-ROUTE-TABLE:
Common node of default-vrf, vrf
- internal-routes: object
-
OSPFv3 internal route information table
Example
{
"internal-routes": {
"internal-route": [
{
"prefix": "string",
"prefix-length": "string",
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-source": [
{
"route-source-id": "string",
"route-source-lsa-type": "integer",
"route-source-adversting-router": "string"
}
],
"route-area-id": "integer",
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
]
}
}
BORDER-ROUTER-TABLE:
Common node of default-vrf, vrf
- border-routers: object
-
OSPFv3 border router information table
Example
{
"border-routers": {
"border-router": [
{
"border-router-id": "string",
"border-router-path": [
{
"interface-name": "string",
"border-router-area-id": "string",
"border-router-type": "string",
"border-router-next-hop": "string",
"border-router-route-metric": "integer",
"spf-version": "integer",
"is-intra-area-router": "boolean"
}
]
}
]
}
}
OSPFV3-EDM-NEIGHBOR-DETAIL:
Detailed OSPFv3 neighbor information
- poll-interval: integer
-
Poll interval (s)
- neighbor-option: integer
-
This is bitmask of neighbor's option field received
- neighbor-designated-router-address: string
-
Address of designated router
- next-poll-interval: integer
-
For NBMA networks, amount of time remaining in seconds before the next poll interval expires and Hello is sent (s)
- interface-type: string none, broadcast, non-broadcast, point-to-point, point-to-multipoint, point-to-multipoint-non-broadcast, virtual-link, loopback-interface, mpls-traffic-engineering, sham-link
-
Interface type
- is-neighbor-filtered: boolean
-
If true, filter outgoing LSAs
- neighbor-retransmission: OSPFV3-EDM-NEIGHBOR-RETRANS
-
Retransmission information with this neighbor
- neighbor-cost: integer
-
Cost of path to this neighbor
- neighbor-backup-designated-router-address: string
-
Address of backup designated router
- neighbor-ignore-timer: integer
-
Remaining time when ignore timer is running
- state-changes: integer
-
Number of state changes
- pending-events: integer
-
Number of pending events
Example
{
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
}
OSPFV3-EDM-LSA-GRACE:
OSPFv3 Grace LSA
- interface-name: string
-
LSA interface handle
- grace-period: integer
-
The grace periord where helper routers should wait before advertising it fully adjacent(s)
- lsa-header: OSPFV3-EDM-DB-HEADER
-
Header information
- is-sham-link: boolean
-
If true, it is a sham link
- lsa-detail: OSPFV3-EDM-DB-DETAIL
-
Detailed LSA information
- virtual-link-id: integer
-
Virtual link ID
- is-virtual-link: boolean
-
If true, it is a virtual link
- sham-link-id: integer
-
Sham link ID
- grace-reason: string grace-reason-unknown, grace-reason-software-restart, grace-reason-software-upgrade, grace-reason-switchover
-
Reason for router restart
Example
{
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer",
"grace-reason": "string"
}
OSPFV3-EDM-LSA-NETWORK:
OSPFv3 Network LSA
- lsa-detail: OSPFV3-EDM-DB-DETAIL
-
Detailed LSA information
- neighbor-router: string[]
- lsa-header: OSPFV3-EDM-DB-HEADER
-
Header information
Example
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"neighbor-router": [
"string"
],
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
OSPFV3-SH-BACKUP-PATH:
OSPFv3 Route Backup Path Information
- node-protect: boolean
-
Node Protect
- downstream: boolean
-
Downstream
- primary-path: boolean
-
Primary Path
- backup-route-source: string
-
IP address of source of route
- backup-route-next-hop-address: string
-
Nexthop IP address
- line-card-disjoint: boolean
-
Line Card Disjoint
- backup-metric: integer
-
Metric
- srlg-disjoint: boolean
-
SRLG Disjoint
- backup-route-interface-name: string
-
Next hop Interface
Example
{
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
}
INTERFACE-BRIEF-PROCESS-TABLE:
Common node of default-vrf, vrf
- interface-brief-process-table: INTERFACE-BRIEF
-
OSPFv3 interface brief information table for all areas
Example
{
"interface-brief-process-table": {
"interface-brief": [
{
"interface-name": "string",
"interface-neighbors": "integer",
"interface-link-cost": "integer",
"interface-adjacent-neighbors": "integer",
"interface-address": "string",
"network-type": "string",
"ospf-interface-state": "string"
}
]
}
}
REQUEST-LIST-PROCESS-TABLE:
Common node of default-vrf, vrf
- request-list-process-table: REQUEST-LIST
-
OSPFv3 request list information for all areas
Example
{
"request-list-process-table": {
"request": [
{
"neighbor-address": "string",
"interface-name": "string",
"request-virtual-link-id": "integer",
"request": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"request-neighbor-address": "string",
"request-sham-link-id": "integer",
"is-request-sham-link": "boolean",
"is-request-virtual-link": "boolean"
}
]
}
}
OSPFV3-EDM-LSA-IAPFX:
OSPFv3 Inter-area Prefix LSA
- priority: string critical, high, medium, low
-
Prefix priority
- lsa-detail: OSPFV3-EDM-DB-DETAIL
-
Detailed LSA Information
- prefix: string
-
LSA address prefix
- prefix-length: integer
-
Prefix length
- lsa-header: OSPFV3-EDM-DB-HEADER
-
Header information
Example
{
"priority": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"prefix": "string",
"prefix-length": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
}
}
OSPFV3-EDM-LSA-UNKNOWN:
OSPFv3 Unknown LSA Database Information
- interface-name: string
-
LSA interface name
- lsa-header: OSPFV3-EDM-DB-HEADER
-
Header information
- is-sham-link: boolean
-
If true, it is a sham link
- lsa-detail: OSPFV3-EDM-DB-DETAIL
-
Detailed LSA information
- virtual-link-id: integer
-
Virtual link ID
- is-virtual-link: boolean
-
If true, it is a virtual link
- sham-link-id: integer
-
Shamlink ID
Example
{
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
}
NSR-PL-SEND-DROP-ARRAY:
NSR PL SEND DROP ARRAY
- nsr-pl-send-drop-array: integer[]
Example
{
"nsr-pl-send-drop-array": [
"integer"
]
}
OSPFV3-EDM-SPF-AREA-STATS:
OSPFv3 SPF Area Statistics Information
- spf-stat-lsa-type-count: integer[]
- spf-stat-time: OSPFV3-SPF-TIME
-
SPF time calculations
- spf-stat-area-id: integer
-
Area ID for area of these SPF statistics
Example
{
"spf-stat-lsa-type-count": [
"integer"
],
"spf-stat-time": {
"rib-del": "integer",
"external-prefix-del": "integer",
"rib-add": "integer",
"inter-prefix-del": "integer",
"intra-prefix": "integer",
"inter-prefix": "integer",
"intra-prefix-del": "integer",
"dijkstra": "integer",
"external-prefix": "integer"
},
"spf-stat-area-id": "integer"
}
OSPFV3-EDM-DATABASE-LSAINFO:
OSPFv3 LSA Information
- lsa-info: OSPFV3-LSA-INFO-UNION
-
Summary of all LSAs or LSA specific information
Example
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean"
}
}
}
BAD-CHECKSUM-TABLE:
Common node of default-vrf, vrf
- bad-checksums: object
-
Bad Checksum Packets information table
Example
{
"bad-checksums": {
"bad-checksum": [
{
"packet-number": "integer",
"timestamp": {
"second": "integer",
"nanosecond": "integer"
},
"computed-checksum": "integer",
"received-data": "string",
"received-checksum": "integer"
}
]
}
}
OSPFV3-EDM-NEIGHBOR:
OSPFv3 neighbor summary information
- neighbor-sham-link-id: integer
-
Neighbor sham link id
- neighbor-up-time: integer
-
Amount of time since the adjacency is up (seconds)
- neighbor-designated-router: string
-
Designated router
- neighbor-dead-timer: integer
-
Time until neighbor's dead timer expires (seconds)
- neighbor-address-xr: string
-
Neighbor IP Address
- neighbor-virtual-link-id: integer
-
Neighbor virtual link id
- neighbor-interface-id: integer
-
Neighbor interface ID
- is-neighbor-virtual-link: boolean
-
If true, neighbor is on a virtual link
- neighbor-detail: OSPFV3-EDM-NEIGHBOR-DETAIL
-
Detailed OSPFv3 neighbor information
- neighbor-bfd-info: OSPFV3-EDM-NEIGHBOR-BFD
-
Neighbor BFD information
- neighbor-state: string neigbhor-down, attempt, init, two-way, exstart, exchange, loading, full, sc-virtual
-
Neighbor's state
- is-neighbor-sham-link: boolean
-
If true, neighbor is on a sham link
- neighbor-dr-priority: integer
-
Neighbor's DR priority
Example
{
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
OSPFV3-EDM-AREA-SUMM:
OSPFv3 Area SPF Information
- sp-fs: integer
-
Number of SPF calculations
- area-id: integer
-
Area ID of the area SPF statistics
Example
{
"sp-fs": "integer",
"area-id": "integer"
}
DATABASE-SUMMARY-TABLE:
Common node of default-vrf, vrf, area
- database-summary-table: object
-
Database summary table
Example
{
"database-summary-table": {
"database-summary": {
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
}
}
OSPFV3-EDM-TOP-PATH:
OSPFv3 topology path information
- interface-index: integer
-
Route path interface Index
- route-backup-path: OSPFV3-SH-BACKUP-PATH
-
Backup Path Info
- route-path-next-hop: string
-
Route path next hop
- interface-name: string
-
Route path interface name
- route-path-id: integer
-
Path ID of path
- neighbor-next-hop: OSPFV3-SH-NNH-INFO
-
NeighborNextHop
Example
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
OSPFV3-EDM-DB-SUMMARY-AREA:
OSPFv3 Area Database Summary
- area-database-summary: OSPFV3-EDM-DB-SUMMARY-COUNTERS
-
Area database summary
- lsa-area-id: string
-
Area ID in decimal or dotted-decimal format
Example
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
OSPFV3-SH-SHAM-LINKS:
OSPFv3 Sham Link
- virtual-link-authentication-spi: integer
-
Sham link authentication spi
- is-sham-link-ip-security-active: boolean
-
If true, Sham link IP security is active
- sham-link-last-gr: integer
-
Time in seconds since last GR
- sham-link-retransmission-interval: integer
-
Retransmission interval (s)
- sham-link-area: string
-
Area id
- is-sham-link-ip-security-required: boolean
-
If true, sham link IP security is required
- sham-link-demand-circuit: boolean
-
If true, the link runs as demand circuit
- sham-link-ifindex: integer
-
Sham-link ifindex
- sham-link-encryption-transmitted: integer
-
Sham link encryption transmitted
- sham-link-authentication-transmit: integer
-
Sham link authentication transmit
- sham-link-neighbor: OSPFV3-SH-SLINK-NEIGHBOR
-
Neighbor information
- sham-link-dest-address: string
-
Sham-link dest
- sham-link-dc-bitless-lsa: integer
-
Number of LSA's with demand circuit bit not set
- sham-link-encryption-spi: integer
-
Sham link encryption spi
- sham-link-dead-interval: integer
-
Dead interval (s)
- sham-link-wait-interval: integer
-
Wait interval (s)
- is-sham-link-authentication-enabled: boolean
-
If true, sham link authentication is enabled
- sham-link-neighbor-id: string
-
Neighbor on other end of this sham link
- sham-link-next-hello: integer
-
Time until next hello (s)
- sham-link-gr-enabled: boolean
-
If true, enabled
- sham-link-transmission-delay: integer
-
Transmission delay in seconds
- sham-link-cost: integer
-
Cost of the sham link
- sham-link-gr: boolean
-
If true, Gracefule restart in progress
- sham-link-passive: boolean
-
If true, interface is passive
- sham-link-encrypted-authentication-transmitted: integer
-
Sham link encrypted authentication transmitted
- is-sham-link-encryption-enabled: boolean
-
If true, sham link encryption is enabled
- sham-link-hello-interval: integer
-
Hello interval (s)
- sham-link-state: string down, loopback, waiting, point-to-multipoint, point-to-point, designated-router, backup-designated-router, other-designated-router
-
OSPF interface state for the sham link
- sham-link-source-address: string
-
Sham-link source
Example
{
"virtual-link-authentication-spi": "integer",
"is-sham-link-ip-security-active": "boolean",
"sham-link-last-gr": "integer",
"sham-link-retransmission-interval": "integer",
"sham-link-area": "string",
"is-sham-link-ip-security-required": "boolean",
"sham-link-demand-circuit": "boolean",
"sham-link-ifindex": "integer",
"sham-link-encryption-transmitted": "integer",
"sham-link-authentication-transmit": "integer",
"sham-link-neighbor": {
"sham-link-state": "string",
"sham-link-suppress-hello": "boolean",
"sham-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
},
"sham-link-dest-address": "string",
"sham-link-dc-bitless-lsa": "integer",
"sham-link-encryption-spi": "integer",
"sham-link-dead-interval": "integer",
"sham-link-wait-interval": "integer",
"is-sham-link-authentication-enabled": "boolean",
"sham-link-neighbor-id": "string",
"sham-link-next-hello": "integer",
"sham-link-gr-enabled": "boolean",
"sham-link-transmission-delay": "integer",
"sham-link-cost": "integer",
"sham-link-gr": "boolean",
"sham-link-passive": "boolean",
"sham-link-encrypted-authentication-transmitted": "integer",
"is-sham-link-encryption-enabled": "boolean",
"sham-link-hello-interval": "integer",
"sham-link-state": "string",
"sham-link-source-address": "string"
}
AREA-TABLE:
Common node of default-vrf, vrf
- areas: object
-
OSPFv3 area table
Example
{
"areas": {
"area": [
{
"flood-list-table": {
"flood": [
{
"interface-name": "string",
"queue-length": "integer",
"as-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"area-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"ls-transmission-timer": "integer",
"link-flood": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
]
}
]
},
"interface-table": {
"interface": [
{
"dead-interval": "integer",
"interface-bfd": {
"bfd-intf-enable-mode": "integer",
"bfd-detection-multiplier": "integer",
"bfd-interval": "integer"
},
"interface-encrypted-authentication-transmitted": "integer",
"network-type": "string",
"is-interface-encryption-enabled": "boolean",
"interface-references": "integer",
"backup-designated-router-address": "string",
"is-interface-ip-security-active": "boolean",
"interface-link-cost": "integer",
"interface-address": "string",
"adjacent-neighbor": "integer",
"configured-ldp-sync": "boolean",
"interface-number": "integer",
"designated-router-address": "string",
"transmission-delay": "integer",
"interface-router-id": "string",
"interface-ldp-sync": "boolean",
"interface-dc-bitless-ls-as": "integer",
"ospf-interface-state": "string",
"designated-router-id": "string"
}
]
},
"database-summary-table": {
"database-summary": {
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
}
}
]
}
}
OSPFV3-EDM-BORDER-ROUTER:
OSPFv3 border router information
- border-router-path: OSPFV3-EDM-BR-PATH
-
List of border router paths
Example
{
"border-router-path": [
{
"interface-name": "string",
"border-router-area-id": "string",
"border-router-type": "string",
"border-router-next-hop": "string",
"border-router-route-metric": "integer",
"spf-version": "integer",
"is-intra-area-router": "boolean"
}
]
}
OSPFV3-EDM-TOPOLOGY-INTERNAL:
OSPFv3 Topology Internal Information
- route-topology: OSPFV3-EDM-TOPOLOGY
-
Common Route topology information
- route-source: OSPFV3-EDM-TOP-SOURCE
-
List of topology source information
- route-area-id: integer
-
Route area ID
- route-path: OSPFV3-EDM-TOP-PATH
-
List of paths to this route
Example
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-source": [
{
"route-source-id": "string",
"route-source-lsa-type": "integer",
"route-source-adversting-router": "string"
}
],
"route-area-id": "integer",
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
NEIGHBOR-PROCESS-TABLE:
Common node of default-vrf, vrf
- neighbor-process-table: NEIGHBOR
-
OSPFv3 neighbor information table for all areas
Example
{
"neighbor-process-table": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
}
VRF-RIB-BATCH-STATS:
Common node of statistics, vrf-statistics
- vrf-rib-batch-stats: OSPFV3-EDM-BATCH-STATS
-
OSPFv3 RIB batch statistics
Example
{
"vrf-rib-batch-stats": {
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
}
OSPFV3-EDM-RAW-STATS:
OSPFv3 raw I/O statistics
- out-error-drops: integer
-
Error Drops
- in-short-drops: integer
-
In Short Drops
- out-bytes: integer
-
Sent Bytes
- in-bytes: integer
-
Received Bytes
- in-queue-drops: integer
-
In Queue Drops
- out-nopak-drops: integer
-
No Packet Buffers
- raw-conn-open: integer
-
Raw Connections Open
- raw-conn-close: integer
-
Raw Connections Close
- in-long-packets: integer
-
Received Long Packets
- in-handle-drops: integer
-
In Handle Drops
- in-error-drops: integer
-
In Error Drops
- raw-conn-state: integer
-
Raw Connection State
- out-pakapi-errors: integer
-
PAK API Errors
- in-packets: integer
-
Received Packets
- in-malloc-drops: integer
-
In Malloc Drops
- out-nofd-drops: integer
-
No FileDescriptor Drops
- raw-conn-error: integer
-
Raw Connections Error
- in-ipsec-drops: integer
-
In IPSEC Drops
- out-ipsec-drops: integer
-
Out IPSEC Drops
- out-packets: integer
-
Packets Sent
Example
{
"out-error-drops": "integer",
"in-short-drops": "integer",
"out-bytes": "integer",
"in-bytes": "integer",
"in-queue-drops": "integer",
"out-nopak-drops": "integer",
"raw-conn-open": "integer",
"raw-conn-close": "integer",
"in-long-packets": "integer",
"in-handle-drops": "integer",
"in-error-drops": "integer",
"raw-conn-state": "integer",
"out-pakapi-errors": "integer",
"in-packets": "integer",
"in-malloc-drops": "integer",
"out-nofd-drops": "integer",
"raw-conn-error": "integer",
"in-ipsec-drops": "integer",
"out-ipsec-drops": "integer",
"out-packets": "integer"
}
OSPFV3-EDM-PREFIX:
OSPFv3 Prefix Type
- priority: string critical, high, medium, low
-
Prefix priority
- prefix: string
-
OSPFv3 prefix
- ospfv3-prefix-metric: integer
-
OSPFv3 prefix metric
- ospfv3-prefix-options: integer
-
OSPFv3 prefix options
- ospfv3-prefix-length: integer
-
OSPFv3 prefix length
Example
{
"priority": "string",
"prefix": "string",
"ospfv3-prefix-metric": "integer",
"ospfv3-prefix-options": "integer",
"ospfv3-prefix-length": "integer"
}
OSPFV3-EDM-BR-PATH:
OSPFv3 border router path
- interface-name: string
-
Next hop interface name
- border-router-area-id: string
-
Area string in decimal or dotted-decimal format
- border-router-type: string abr, asbr, abr-asbr
-
Border router type
- border-router-next-hop: string
-
Next hop address
- border-router-route-metric: integer
-
Metric
- spf-version: integer
-
SPF version
- is-intra-area-router: boolean
-
If true, intra-area router else inter-area router
Example
{
"interface-name": "string",
"border-router-area-id": "string",
"border-router-type": "string",
"border-router-next-hop": "string",
"border-router-route-metric": "integer",
"spf-version": "integer",
"is-intra-area-router": "boolean"
}
VRF-STATISTICS:
Common node of default-vrf, vrf
- vrf-statistics: VRF-RIB-BATCH-STATS
-
Container for Statistics
Example
{
"vrf-statistics": {
"vrf-rib-batch-stats": {
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
}
}
OSPFV3-EDM-VIRTUAL-LINKS:
OSPFv3 virtual link information
- is-virtual-link-ip-security-required: boolean
-
If true, virtual link IP security is required
- virtual-link-dc-bitless-lsa: integer
-
Number of LSA's with demand circuit bit not set
- virtual-link-cost: integer
-
Cost of the virtual link
- virtual-link-neighbor-id: string
-
Neighbor on other end of this virtual link
- virtual-link-encrypted-authentication-transmitted: integer
-
Virtual link encrypted authentication transmitted
- virtual-link-next-hello: integer
-
Time until next hello (s)
- virtual-link-dead-interval: integer
-
Dead interval (s)
- is-virtual-link-demand-circuit: boolean
-
If true, the link runs as demand circuit
- virtual-link-hello-interval: integer
-
Hello interval (s)
- virtual-link-state: string down, loopback, waiting, point-to-multipoint, point-to-point, designated-router, backup-designated-router, other-designated-router
-
OSPF interface state for the virtual link
- virtual-link-encryption-spi: integer
-
Virtual link encryption spi
- virtual-link-wait-interval: integer
-
Wait interval (s)
- virtual-link-neighbor: OSPFV3-EDM-VLINK-NEIGHBOR
-
Neighbor information
- virtual-link-authentication-spi: integer
-
Virtual link authentication spi
- virtual-link-retransmission-interval: integer
-
Retransmission interval (s)
- virtual-link-encryption-transmitted: integer
-
Virtual link encryption transmitted
- is-virtual-link-encryption-enabled: boolean
-
If true, virtual link encryption is enabled
- virtual-link-neighbor-address: string
-
Virtual link neighbor addresss
- transit-area-id: string
-
Transit area id
- is-virtual-link-authentication-enabled: boolean
-
If true, virtual link authentication is enabled
- interface-name: string
-
Interface on which this virtual link is formed
- virual-link-transmission-delay: integer
-
Transmission delay in seconds
- virtual-link-authentication-transmit: integer
-
Virtual link authentication transmit
- is-virtual-link-ip-security-active: boolean
-
If true, Virtual link IP security is active
- is-virtual-link-passive: boolean
-
If true, interface is passive
- virtual-link-interface-number: integer
-
Virtual link interface number
Example
{
"is-virtual-link-ip-security-required": "boolean",
"virtual-link-dc-bitless-lsa": "integer",
"virtual-link-cost": "integer",
"virtual-link-neighbor-id": "string",
"virtual-link-encrypted-authentication-transmitted": "integer",
"virtual-link-next-hello": "integer",
"virtual-link-dead-interval": "integer",
"is-virtual-link-demand-circuit": "boolean",
"virtual-link-hello-interval": "integer",
"virtual-link-state": "string",
"virtual-link-encryption-spi": "integer",
"virtual-link-wait-interval": "integer",
"virtual-link-neighbor": {
"virtual-link-state": "string",
"is-virtual-link-hello-suppressed": "boolean",
"virtual-link-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
},
"virtual-link-authentication-spi": "integer",
"virtual-link-retransmission-interval": "integer",
"virtual-link-encryption-transmitted": "integer",
"is-virtual-link-encryption-enabled": "boolean",
"virtual-link-neighbor-address": "string",
"transit-area-id": "string",
"is-virtual-link-authentication-enabled": "boolean",
"interface-name": "string",
"virual-link-transmission-delay": "integer",
"virtual-link-authentication-transmit": "integer",
"is-virtual-link-ip-security-active": "boolean",
"is-virtual-link-passive": "boolean",
"virtual-link-interface-number": "integer"
}
OSPFV3-EDM-DB-DETAIL:
OSPFv3 Detailed LSA Database Information
- is-flood-pending: boolean
-
If true, the reason not to delete this LSA is because waiting for flooding or retransmission
- minute-table-index: integer
-
Minute table index
- is-advertising-router-reachable: boolean
-
If true, Advertising Router is reachable
- nsr-flood-required: boolean
-
If true, the reason not to delete this LSA is because it is pending flooding on switchover
- is-acknowledged: boolean
-
If true, the reason not to delete this LSA is because it's Acknowledgement list is not empty
- lsa-flood-required-post-fail-over: boolean
-
LSA flood required after FO
- is-deleted: boolean
-
If true, flag is set to delete this LSA
- second-table-index: integer
-
Second table index
- is-partial-spf: boolean
-
If true, the reason not to delete this LSA is because it is in partial SPF queue
- lsa-length: integer
-
Length of the LSA
- is-no-delete: boolean
-
If true, the reason not to delete this LSA is because delete flag not set on this LSA
- rate-limit: boolean
-
If true, the reason not to delete this LSA is because waiting for next wait-interval to expire
- is-routing-table: boolean
-
If true, the reason not to delete this LSA is because it has a contributing entry in the routing table
- is-neighbor-exchange: boolean
-
If true, the reason not to delete this LSA is because neighbor is in exchange state
- free-time: integer
-
The amount of time since the last check was made to free this LSA (s)
- is-maximum-aged: boolean
-
If true, the reason not to delete this LSA is because it is in Maxage Queue
- lsa-sync-state: string none, out-of-sync, in-sync, nsr-ack-pending
-
State of LSA sync with active
- is-nsr-ack-pending: boolean
-
If true, the reason not to delete this LSA is because NSR ACK from standby is pending
- is-routing-bit: boolean
-
If true, Routing Bit set on the LSA
Example
{
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
}
EXTERNAL-ROUTE-TABLE:
Common node of default-vrf, vrf
- external-routes: object
-
OSPFv3 external route information table
Example
{
"external-routes": {
"external-route": [
{
"prefix": "string",
"prefix-length": "string",
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-extended-community": {
"extended-community-domain-id-value": "string",
"extended-community-area-id": "integer",
"extended-community-router-id": "string",
"extended-community-route-type": "integer",
"extended-community-options": "integer",
"extended-communityl-domain-id-type": "integer"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
]
}
}
OSPFV3-EDM-SUMMARY-PREFIX:
OSPFv3 summary prefix information
- prefix-metric: integer
-
Prefix metric
- prefix-metric-type: string type-none, type1, type2
-
Prefix metric type
- tag: integer
-
Tag
Example
{
"prefix-metric": "integer",
"prefix-metric-type": "string",
"tag": "integer"
}
OSPFV3-EDM-REQUEST:
OSPFv3 request list information
- request-virtual-link-id: integer
-
Request virtual link ID
- request: OSPFV3-EDM-LSA-SUM
-
List of request list entries
- request-neighbor-address: string
-
Neighbor IP address
- request-sham-link-id: integer
-
Request sham link ID
- is-request-sham-link: boolean
-
If true, sham link is requested
- is-request-virtual-link: boolean
-
If true, virtual link is requested
Example
{
"request-virtual-link-id": "integer",
"request": [
{
"header-lsa-age": "integer",
"header-sequence-number": "string",
"header-advertising-router": "string",
"header-lsa-type": "string",
"header-lsa-id": "string"
}
],
"request-neighbor-address": "string",
"request-sham-link-id": "integer",
"is-request-sham-link": "boolean",
"is-request-virtual-link": "boolean"
}
AREA-INFORMATION-TABLE:
Common node of default-vrf, vrf
- area-informations: object
-
OSPFv3 area information table
Example
{
"area-informations": {
"area-information": [
{
"area-id": "integer",
"is-area-stubbed": "boolean",
"is-rrr-enabled": "boolean",
"area-lfa-revision": "integer",
"is-nssa-translated": "boolean",
"indication-ls-as": "integer",
"is-area-nssa": "boolean",
"is-backbone-area-active": "boolean",
"area-lfa-interface-count": "integer",
"area-interfaces": "integer",
"is-area-total-stubbed": "boolean",
"area-opaque-lsas": "integer",
"is-nssa-translated-always": "boolean",
"flood-list-length": "integer",
"stub-default-cost": "integer",
"is-nssa-default": "boolean",
"sp-fs": "integer",
"area-per-prefix-lfa-interface-count": "integer",
"area-opaque-lsa-checksum": "integer",
"nssa-no-redistribution": "boolean",
"area-range": [
{
"range-prefix": "string",
"net-cost": "integer",
"range-prefix-length": "integer",
"status": "string",
"is-cost-configured": "boolean"
}
],
"area-dc-bitless-ls-as": "integer",
"do-not-age-ls-as": "integer"
}
]
}
}
OSPFV3-EDM-LSA-EXTERNAL:
OSPFv3 External LSA
- prefix-length: integer
-
Prefix length
- external-tag: integer
-
Route Tag
- tos-cost: integer
-
Type of service cost metric
- metric-type: string type-none, type1, type2
-
Metric type
- lsa-detail: OSPFV3-EDM-DB-DETAIL
-
Detailed LSA Information
- priority: string critical, high, medium, low
-
Prefix priority
- prefix: string
-
IPV6 address prefix
- forwarding-address: string
-
Forwarding Address
- lsa-header: OSPFV3-EDM-DB-HEADER
-
Header information
- is-forwarding-address-set: boolean
-
If true, forwarding address is set
Example
{
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
}
OSPFV3-SH-NNH-INFO:
OSPF Neighbor NextHop Information
- neighbor-next-hop-intf-index: integer
-
Neighbor NextHop Interface Index
Example
{
"neighbor-next-hop-intf-index": "integer"
}
OSPFV3-EDM-TOPOLOGY:
OSPFv3 Topology Information
- route-type: integer
-
Route type
- route-distance: integer
-
Route distance
- route-cost: integer
-
Route cost
- route-id: string
-
Route ID
Example
{
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
}
OSPFV3-NSR-ERR-INFO-BAG:
OSPFV3 NSR ERR INFO BAG
- last-err-time: OSPFV3-EDM-TIME
-
Time this error was last hit
- err-info-string: string
-
Error Information
- err-count: string
-
Count this error hit during the Nsr Revision
Example
{
"last-err-time": {
"second": "integer",
"nanosecond": "integer"
},
"err-info-string": "string",
"err-count": "string"
}
OSPFV3-EDM-LSA-IARTR:
OSPFv3 Inter-area Router LSA
- lsa-detail: OSPFV3-EDM-DB-DETAIL
-
Detailed LSA information
- lsa-header: OSPFV3-EDM-DB-HEADER
-
Header information
- lsa-router-id: integer
-
LSA router ID
Example
{
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"lsa-router-id": "integer"
}
OSPFV3-EDM-PROTO-STATS:
OSPFv3 protocol statistics
- ls-req-in-packets: integer
-
LSA Requests in
- ls-upd-in-ignored: integer
-
LS Updates ignored
- total-out-packets: integer
-
Total Out Packets
- ls-req-in-ls-as: integer
-
LS Requests in
- ls-ack-out-packets: integer
-
LS Ack Packets out
- ls-req-out-packets: integer
-
LS Request Packets out
- total-in-packets: integer
-
Total inputs packets
- ls-ack-in-ls-as: integer
-
LS Ack LSAs in
- dropped-in-gs: integer
-
Dropped in GS
- dbdes-in-ls-as: integer
-
Database Description LSAs in
- ls-upd-out-ls-as: integer
-
LS Update LSAs out
- hello-out-packets: integer
-
Hello Out Packets
- dbdes-out-ls-as: integer
-
Database Description LSAs out
- ls-upd-in-packets: integer
-
LS Updates Packets in
- checksum-err: integer
-
Checksum Errors
- ls-upd-out-packets: integer
-
LS Update Packets out
- ls-req-out-ls-as: integer
-
LS Reuqests LSAs out
- ls-upd-in-ls-as: integer
-
LS Updates LSAs in
- dbdes-out-packets: integer
-
Database Description Packets out
- ls-ack-in-packets: integer
-
LS Acks Packets in
- ls-ack-out-ls-as: integer
-
LS Ack LSAs out
- hello-in-packets: integer
-
Hello packets in
- dbdes-in-packets: integer
-
Database Description Packets in
Example
{
"ls-req-in-packets": "integer",
"ls-upd-in-ignored": "integer",
"total-out-packets": "integer",
"ls-req-in-ls-as": "integer",
"ls-ack-out-packets": "integer",
"ls-req-out-packets": "integer",
"total-in-packets": "integer",
"ls-ack-in-ls-as": "integer",
"dropped-in-gs": "integer",
"dbdes-in-ls-as": "integer",
"ls-upd-out-ls-as": "integer",
"hello-out-packets": "integer",
"dbdes-out-ls-as": "integer",
"ls-upd-in-packets": "integer",
"checksum-err": "integer",
"ls-upd-out-packets": "integer",
"ls-req-out-ls-as": "integer",
"ls-upd-in-ls-as": "integer",
"dbdes-out-packets": "integer",
"ls-ack-in-packets": "integer",
"ls-ack-out-ls-as": "integer",
"hello-in-packets": "integer",
"dbdes-in-packets": "integer"
}
OSPFV3-EDM-PROTOCOL:
OSPFv3 Protocol Information
- administrative-distance-inter-area: integer
-
Administrative Distance for Inter Area routes
- protocol-router-id: string
-
Protocol router ID
- is-graceful-restart: boolean
-
If true, Graceful restart is enabled
- administrative-distance: integer
-
Administrative distance
- administrative-distance-external: integer
-
Administrative Distance for External routes
- distribute-list-in: string
-
Distribute List In
Example
{
"administrative-distance-inter-area": "integer",
"protocol-router-id": "string",
"is-graceful-restart": "boolean",
"administrative-distance": "integer",
"administrative-distance-external": "integer",
"distribute-list-in": "string"
}
OSPF-SH-NSR-SCHED-STATS:
OSPF SH NSR SCHED STATS
- nsr-pulse-quant: string
-
Events processed per pulse
- nsr-events-rx: integer
-
Events processed
- nsr-good-pulses-rx: integer
-
Good pulses received
- nsr-bad-pulses-rx: integer
-
Bad pulses received
- nsr-events-in-q: integer
-
Events pending
- nsr-pri: OSPF-SH-NSR-STATS-PRI
-
nsr pri
- nsr-pulse-tx-fails: integer
-
Pulse send failures
- nsr-events-tx: integer
-
Events to Router thread
- nsr-pulses-tx: integer
-
Pulses to Router thread
Example
{
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
}
OSPFV3-EDM-NEIGHBOR-RETRANS:
OSPFv3 neighbor retransmission information
- area-next-flood: integer
-
Next flood item for area scope LSAs
- link-first-flood: integer
-
Link first flood information
- link-flood-index: integer
-
Link flood index
- as-first-flood-index: integer
-
Index for first flood item for AS scope LSAs
- link-next-flood: integer
-
Link next flood information
- database-descriptor-retransmissions: integer
-
Number of database descriptor retransmissions during last exchange
- area-flood-index: integer
-
Area scope LSA's flood index
- link-next-flood-index: integer
-
Link next flood information index
- retransmissions: integer
-
Number of retransmissions for this neighbor
- maximum-retransmission-length: integer
-
Maximum number of LSAs sent in a retransmission
- neighbor-retransmissions: integer
-
Number of neighbor retransmissions
- as-flood-index: integer
-
AS scope LSA's flood index
- area-first-flood-index: integer
-
Index of the first flood item for area scope LSAs
- lsa-retransmission-timer: integer
-
Time until next LSA retransmission (ms)
- last-retransmission-length: integer
-
Number of LSAs sent in last retransmission
- as-first-flood: integer
-
First flood item for AS scope LSAs
- as-next-flood: integer
-
Next flood item for AS scope LSAs
- link-first-flood-index: integer
-
Link first flood information index
- area-first-flood: integer
-
First flood item for area scope LSAs
- last-retransmission-time: integer
-
Last retransmission scan time (ms)
- area-next-flood-index: integer
-
Index of next flood item for Area scope LSAs
- as-next-flood-index: integer
-
Index of next flood item for AS scope LSAs
- maximum-retransmission-time: integer
-
Maximum retransmission scan time (ms)
Example
{
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
}
LSA:
Common node of lsa-table, lsa-internal-table
- lsa: object[]
-
Database LSA information
Example
{
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string"
}
}
}
}
]
}
OSPFV3-SH-ROUTE-EXTENDED-COMM:
OSPF External Route Extended Community Information
- extended-community-domain-id-value: string
-
Domain ID value
- extended-community-area-id: integer
-
Area id
- extended-community-router-id: string
-
Router id
- extended-community-route-type: integer
-
Route type
- extended-community-options: integer
-
Route Options
- extended-communityl-domain-id-type: integer
-
Domain ID type
Example
{
"extended-community-domain-id-value": "string",
"extended-community-area-id": "integer",
"extended-community-router-id": "string",
"extended-community-route-type": "integer",
"extended-community-options": "integer",
"extended-communityl-domain-id-type": "integer"
}
ospfv3_schema:
OSPFv3 operational information
- processes: object
-
OSPFv3 Process Table
Example
{
"processes": {
"process": [
{
"statistics": {
"issu-stats": {
"nsr-lsa-qad-mdata-count": "integer",
"nsr-nbr-init-sync-pend-count": "string",
"nsr-mtu": "integer",
"nsr-nbr-qad-mdata-count": "integer",
"nsr-conn-to-active-closes": "integer",
"nsr-conn-to-active-errors": "integer",
"nsr-nbr-seq-no": "integer",
"nsr-conn-to-active-opens": "integer",
"nsr-issu-milestone": [
{
"milestone-name": "string",
"milestone-status": "string"
}
],
"nsr-version": "integer",
"nsr-intf-seq-no": "integer",
"nsr-tmr-quant": "string",
"nsr-fsm-running-timer": [
"string"
],
"nsr-lsa-init-sync-pend-count": "string",
"nsr-peer-node-id": "integer",
"nsr-fsm-flag": [
"string"
],
"nsr-conn-to-active-attempts": "integer",
"nsr-conn-to-active-fails": "integer",
"nsr-peer-version": "integer",
"nsr-thd-stats": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-rtr-thd-sched": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-revision": "string",
"nsr-node-id": "integer",
"nsr-lsa-qad-qid": "integer",
"nsr-nbr-qad-qid": "integer",
"nsr-err-history": [
{
"nsr-error-info": [
null
]
}
]
},
"vrf-rib-batch-stats": {
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
}
}
]
}
}
processes_schema:
OSPFv3 Process Table
- process: object[]
-
OSPFv3 Operational data for a particular OSPFv3 process
Example
{
"process": [
{
"statistics": {
"issu-stats": {
"nsr-lsa-qad-mdata-count": "integer",
"nsr-nbr-init-sync-pend-count": "string",
"nsr-mtu": "integer",
"nsr-nbr-qad-mdata-count": "integer",
"nsr-conn-to-active-closes": "integer",
"nsr-conn-to-active-errors": "integer",
"nsr-nbr-seq-no": "integer",
"nsr-conn-to-active-opens": "integer",
"nsr-issu-milestone": [
{
"milestone-name": "string",
"milestone-status": "string"
}
],
"nsr-version": "integer",
"nsr-intf-seq-no": "integer",
"nsr-tmr-quant": "string",
"nsr-fsm-running-timer": [
"string"
],
"nsr-lsa-init-sync-pend-count": "string",
"nsr-peer-node-id": "integer",
"nsr-fsm-flag": [
"string"
],
"nsr-conn-to-active-attempts": "integer",
"nsr-conn-to-active-fails": "integer",
"nsr-peer-version": "integer",
"nsr-thd-stats": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-rtr-thd-sched": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-revision": "string",
"nsr-node-id": "integer",
"nsr-lsa-qad-qid": "integer",
"nsr-nbr-qad-qid": "integer",
"nsr-err-history": [
{
"nsr-error-info": [
{}
]
}
]
},
"vrf-rib-batch-stats": {
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
}
}
]
}
process_schema:
- statistics:
-
Container for Statistics
- default-vrf: NEIGHBOR-DETAIL-PROCESS-TABLE
-
Operational data for the default VRF (instance) in the OSPFv3 process
- process-name: string
-
Particular OSPFv3 process
- vrfs: object
-
Table for each VRF
Example
{
"statistics": {
"issu-stats": {
"nsr-lsa-qad-mdata-count": "integer",
"nsr-nbr-init-sync-pend-count": "string",
"nsr-mtu": "integer",
"nsr-nbr-qad-mdata-count": "integer",
"nsr-conn-to-active-closes": "integer",
"nsr-conn-to-active-errors": "integer",
"nsr-nbr-seq-no": "integer",
"nsr-conn-to-active-opens": "integer",
"nsr-issu-milestone": [
{
"milestone-name": "string",
"milestone-status": "string"
}
],
"nsr-version": "integer",
"nsr-intf-seq-no": "integer",
"nsr-tmr-quant": "string",
"nsr-fsm-running-timer": [
"string"
],
"nsr-lsa-init-sync-pend-count": "string",
"nsr-peer-node-id": "integer",
"nsr-fsm-flag": [
"string"
],
"nsr-conn-to-active-attempts": "integer",
"nsr-conn-to-active-fails": "integer",
"nsr-peer-version": "integer",
"nsr-thd-stats": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-rtr-thd-sched": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-revision": "string",
"nsr-node-id": "integer",
"nsr-lsa-qad-qid": "integer",
"nsr-nbr-qad-qid": "integer",
"nsr-err-history": [
{
"nsr-error-info": [
{
"last-err-time": {}
}
]
}
]
},
"vrf-rib-batch-stats": {
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
}
}
vrfs_schema:
Table for each VRF
- vrf: object[]
-
Operational data for a particular VRF (instance) in the OSPFv3 process
Example
{
"vrf": [
{
"vrf-name": "string",
"neighbor-detail-process-table": {
"neighbor-detail": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
}
]
}
vrf_schema:
- vrf-name: string
-
VRF Name
Example
{
"vrf-name": "string",
"neighbor-detail-process-table": {
"neighbor-detail": [
{
"neighbor-address": "string",
"interface-name": "string",
"neighbor-sham-link-id": "integer",
"neighbor-up-time": "integer",
"neighbor-designated-router": "string",
"neighbor-dead-timer": "integer",
"neighbor-address-xr": "string",
"neighbor-virtual-link-id": "integer",
"neighbor-interface-id": "integer",
"is-neighbor-virtual-link": "boolean",
"neighbor-detail": {
"poll-interval": "integer",
"neighbor-option": "integer",
"neighbor-designated-router-address": "string",
"next-poll-interval": "integer",
"interface-type": "string",
"is-neighbor-filtered": "boolean",
"neighbor-retransmission": {
"area-next-flood": "integer",
"link-first-flood": "integer",
"link-flood-index": "integer",
"as-first-flood-index": "integer",
"link-next-flood": "integer",
"database-descriptor-retransmissions": "integer",
"area-flood-index": "integer",
"link-next-flood-index": "integer",
"retransmissions": "integer",
"maximum-retransmission-length": "integer",
"neighbor-retransmissions": "integer",
"as-flood-index": "integer",
"area-first-flood-index": "integer",
"lsa-retransmission-timer": "integer",
"last-retransmission-length": "integer",
"as-first-flood": "integer",
"as-next-flood": "integer",
"link-first-flood-index": "integer",
"area-first-flood": "integer",
"last-retransmission-time": "integer",
"area-next-flood-index": "integer",
"as-next-flood-index": "integer",
"maximum-retransmission-time": "integer"
},
"neighbor-cost": "integer",
"neighbor-backup-designated-router-address": "string",
"neighbor-ignore-timer": "integer",
"state-changes": "integer",
"pending-events": "integer"
},
"neighbor-bfd-info": {
"bfd-status-flag": "integer",
"bfd-intf-enable-mode": "integer"
},
"neighbor-state": "string",
"is-neighbor-sham-link": "boolean",
"neighbor-dr-priority": "integer"
}
]
}
}
summary-prefixes_schema:
Summary prefix information table
- summary-prefix: OSPFV3-EDM-SUMMARY-PREFIX
-
Summary prefix information
Example
{
"summary-prefix": [
{
"prefix-metric": "integer",
"prefix-metric-type": "string",
"tag": "integer"
}
]
}
border-routers_schema:
OSPFv3 border router information table
- border-router: OSPFV3-EDM-BORDER-ROUTER
-
OSPFv3 border router information
Example
{
"border-router": [
{
"border-router-path": [
{
"interface-name": "string",
"border-router-area-id": "string",
"border-router-type": "string",
"border-router-next-hop": "string",
"border-router-route-metric": "integer",
"spf-version": "integer",
"is-intra-area-router": "boolean"
}
]
}
]
}
area-informations_schema:
OSPFv3 area information table
- area-information: OSPFV3-EDM-AREA
-
OSPFv3 area information
Example
{
"area-information": [
{
"is-area-stubbed": "boolean",
"is-rrr-enabled": "boolean",
"area-lfa-revision": "integer",
"is-nssa-translated": "boolean",
"indication-ls-as": "integer",
"is-area-nssa": "boolean",
"is-backbone-area-active": "boolean",
"area-lfa-interface-count": "integer",
"area-interfaces": "integer",
"is-area-total-stubbed": "boolean",
"area-opaque-lsas": "integer",
"is-nssa-translated-always": "boolean",
"flood-list-length": "integer",
"stub-default-cost": "integer",
"is-nssa-default": "boolean",
"sp-fs": "integer",
"area-per-prefix-lfa-interface-count": "integer",
"area-opaque-lsa-checksum": "integer",
"nssa-no-redistribution": "boolean",
"area-range": [
{
"range-prefix": "string",
"net-cost": "integer",
"range-prefix-length": "integer",
"status": "string",
"is-cost-configured": "boolean"
}
],
"area-dc-bitless-ls-as": "integer",
"do-not-age-ls-as": "integer"
}
]
}
database-table_schema:
OSPF Link State Database
Example
{
"lsa-table": {
"lsa": [
{
"lsa-info": {
"nssalsa-type": {
"prefix-length": "integer",
"external-tag": "integer",
"tos-cost": "integer",
"metric-type": "string",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"priority": "string",
"prefix": "string",
"forwarding-address": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-forwarding-address-set": "boolean"
},
"unknown-lsa-type": {
"interface-name": "string",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer",
"is-do-not-age-lsa": "boolean",
"advertising-router": "string",
"ls-id": "integer",
"is-graceful-restart-active": "boolean",
"lsa-area-id": "string"
},
"is-sham-link": "boolean",
"lsa-detail": {
"is-flood-pending": "boolean",
"minute-table-index": "integer",
"is-advertising-router-reachable": "boolean",
"nsr-flood-required": "boolean",
"is-acknowledged": "boolean",
"lsa-flood-required-post-fail-over": "boolean",
"is-deleted": "boolean",
"second-table-index": "integer",
"is-partial-spf": "boolean",
"lsa-length": "integer",
"is-no-delete": "boolean",
"rate-limit": "boolean",
"is-routing-table": "boolean",
"is-neighbor-exchange": "boolean",
"free-time": "integer",
"is-maximum-aged": "boolean",
"lsa-sync-state": "string",
"is-nsr-ack-pending": "boolean",
"is-routing-bit": "boolean"
},
"virtual-link-id": "integer",
"is-virtual-link": "boolean",
"sham-link-id": "integer"
},
"grace-lsa": {
"interface-name": "string",
"grace-period": "integer",
"lsa-header": {
"lsa-type": "integer",
"sequence-number": "integer",
"lsa-age": "integer",
"checksum": "integer"
}
}
}
}
]
}
}
redistributions_schema:
Redistribution information table
- redistribution: OSPFV3-EDM-REDIST
-
Redistribution information
Example
{
"redistribution": [
{
"red-metric": "integer",
"policy-name": "string",
"red-tag": "integer",
"red-metric-type": "integer",
"red-metric-flag": "boolean",
"red-mtype-flag": "boolean",
"process-id": "string",
"protocol-name-xr": "string"
}
]
}
external-routes_schema:
OSPFv3 external route information table
- external-route: OSPFV3-EDM-TOPOLOGY-EXTERNAL
-
OSPFv3 external route information
Example
{
"external-route": [
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-extended-community": {
"extended-community-domain-id-value": "string",
"extended-community-area-id": "integer",
"extended-community-router-id": "string",
"extended-community-route-type": "integer",
"extended-community-options": "integer",
"extended-communityl-domain-id-type": "integer"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
]
}
areas_schema:
OSPFv3 area table
- area: DATABASE-SUMMARY-TABLE
-
Per-area information
Example
{
"area": [
{
"database-summary-table": {
"database-summary": {
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
}
}
]
}
database-summary-table_schema:
Database summary table
- database-summary: OSPFV3-EDM-DB-SUMMARY
-
Database Summary information
Example
{
"database-summary": {
"area-database": [
{
"area-database-summary": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
},
"lsa-area-id": "string"
}
],
"is-opaque-database-capable": "boolean",
"database-router-id": "string",
"database-counters": {
"lsa-checksum": [
"integer"
],
"deleted-lsa": [
"integer"
],
"max-age-lsa": [
"integer"
],
"lsa": [
"integer"
]
}
}
}
internal-routes_schema:
OSPFv3 internal route information table
- internal-route: OSPFV3-EDM-TOPOLOGY-INTERNAL
-
OSPFv3 internal route information
Example
{
"internal-route": [
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-source": [
{
"route-source-id": "string",
"route-source-lsa-type": "integer",
"route-source-adversting-router": "string"
}
],
"route-area-id": "integer",
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
]
}
protocol-areas_schema:
Protocol area table
- protocol-area: OSPFV3-EDM-PROTO-AREA
-
Area information
Example
{
"protocol-area": [
{
"protocol-interface": [
{
"distribute-list-in": "string",
"interface-name": "string"
}
],
"distribute-list-in": "string",
"protocol-area-id": "string"
}
]
}
connected-routes_schema:
OSPFv3 connected route information table
- connected-route: OSPFV3-EDM-TOPOLOGY-CONNECTED
-
OSPFv3 connected route information
Example
{
"connected-route": [
{
"route-topology": {
"route-type": "integer",
"route-distance": "integer",
"route-cost": "integer",
"route-id": "string"
},
"route-path": [
{
"interface-index": "integer",
"route-backup-path": {
"node-protect": "boolean",
"downstream": "boolean",
"primary-path": "boolean",
"backup-route-source": "string",
"backup-route-next-hop-address": "string",
"line-card-disjoint": "boolean",
"backup-metric": "integer",
"srlg-disjoint": "boolean",
"backup-route-interface-name": "string"
},
"route-path-next-hop": "string",
"interface-name": "string",
"route-path-id": "integer",
"neighbor-next-hop": [
{
"neighbor-next-hop-intf-index": "integer"
}
]
}
]
}
]
}
protocol-stats_schema:
Protocol table
- protocol-stat: OSPFV3-EDM-PROTO-STATS
-
Protocol statistics for an interface
Example
{
"protocol-stat": [
{
"ls-req-in-packets": "integer",
"ls-upd-in-ignored": "integer",
"total-out-packets": "integer",
"ls-req-in-ls-as": "integer",
"ls-ack-out-packets": "integer",
"ls-req-out-packets": "integer",
"total-in-packets": "integer",
"ls-ack-in-ls-as": "integer",
"dropped-in-gs": "integer",
"dbdes-in-ls-as": "integer",
"ls-upd-out-ls-as": "integer",
"hello-out-packets": "integer",
"dbdes-out-ls-as": "integer",
"ls-upd-in-packets": "integer",
"checksum-err": "integer",
"ls-upd-out-packets": "integer",
"ls-req-out-ls-as": "integer",
"ls-upd-in-ls-as": "integer",
"dbdes-out-packets": "integer",
"ls-ack-in-packets": "integer",
"ls-ack-out-ls-as": "integer",
"hello-in-packets": "integer",
"dbdes-in-packets": "integer"
}
]
}
summary_schema:
OSPFv3 summary
- route: OSPFV3-EDM-ROUTE-SUM
-
OSPFv3 route summary
- protocol: OSPFV3-EDM-PROTOCOL
-
OSPFv3 protocol summary
- ospfv3: OSPFV3-EDM-SUMMARY
-
OSPFv3 summary
Example
{
"route": {
"total-sent-route": "integer",
"inter-area-route": "integer",
"nssa-two-route": "integer",
"extern-two-route": "integer",
"route-connected": "integer",
"redistribution-route": "integer",
"intra-area-route": "integer",
"nssa-one-route": "integer",
"extern-one-route": "integer",
"total-received-route": "integer",
"route-id": "string"
},
"protocol": {
"administrative-distance-inter-area": "integer",
"protocol-router-id": "string",
"is-graceful-restart": "boolean",
"administrative-distance": "integer",
"administrative-distance-external": "integer",
"distribute-list-in": "string"
},
"ospfv3": {
"is-nsr-enabled": "boolean",
"normal-areas": "integer",
"is-router-id-stalled": "boolean",
"last-nsf-time": "integer",
"lsa-hold-time": "integer",
"metric": "integer",
"is-grace-restart-enabled": "boolean",
"stub-areas": "integer",
"grace-resync-time": "integer",
"ipfrr-tiebreakers": [
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
],
"snmp-trap-enabled": "boolean",
"spf-start-time": "integer",
"default-metric": "integer",
"as-dc-bitless-ls-as": "integer",
"router-id": "string",
"spf-hold-time": "integer",
"context-name": "string",
"reference-bandwidth": "integer",
"as-lsa-flood-list-length": "integer",
"domain-id": {
"secondary-domain-id": [
{
"domain-id-type": "integer",
"domain-id-value": "string"
}
],
"primary-domain-id": {
"domain-id-type": "integer",
"domain-id-value": "string"
}
},
"role": "integer",
"lsa-maximum-time": "integer",
"default-tag": "integer",
"is-default-originated": "boolean",
"is-opaque-capable": "boolean",
"opaque-lsas": "integer",
"is-nsr-switchover-on-restart": "boolean",
"is-area-border-router": "boolean",
"spf-maximum-time": "integer",
"maximum-paths": "integer",
"nssa-areas": "integer",
"lsa-retransmission-pacing-interval": "integer",
"default-metric-type": "string",
"minimum-lsa-interval": "integer",
"maximum-interfaces": "integer",
"redistribution-threshold": "integer",
"is-role-standby": "boolean",
"as-ls-as": "integer",
"lsa-group-interval": "integer",
"lsa-flood-pacing-interval": "integer",
"is-auto-cost": "boolean",
"redistribution-limit": "integer",
"areas": "integer",
"is-as-border-router": "boolean",
"opaque-lsa-checksum": "integer",
"stub-router": [
{
"remaining-time": "integer",
"include-stub-links": "boolean",
"start-time": {
"second": "integer",
"nanosecond": "integer"
},
"unset-time": {
"second": "integer",
"nanosecond": "integer"
},
"summary-lsa-metric": "integer",
"abr-off-reason": "string",
"external-lsa-metric": "integer",
"trigger": [
null
]
}
]
}
}
bad-checksums_schema:
Bad Checksum Packets information table
- bad-checksum: OSPFV3-SH-BAD-CHECKSUM
-
Bad Checksum Packet information
Example
{
"bad-checksum": [
{
"timestamp": {
"second": "integer",
"nanosecond": "integer"
},
"computed-checksum": "integer",
"received-data": "string",
"received-checksum": "integer"
}
]
}
fast-reroutes_schema:
OSPFv3 fast reroute topology information table
- fast-reroute: OSPFV3-SH-IPFRR-TOPO
-
OSPFv3 fast reroute topology information
Example
{
"fast-reroute": [
{
"ipfrr-router-id": "string",
"ipfrr-area-revision": "integer",
"ipfrr-topo": [
{
"distance": "integer",
"neighbor-sourced": "boolean",
"lsaid": "integer",
"type4": "boolean",
"dr": "boolean",
"node-id": "string",
"revision": "integer"
}
],
"ipfrr-topo-area-id": "string"
}
]
}
statistics_schema:
Container for Statistics
- issu-stats: OSPFV3-EDM-NSR-STATS
-
OSPF ISSU statistics
- nsr-stats: OSPFV3-EDM-NSR-STATS
-
OSPF NSR statistics
- nsr-pl-stats: OSPF-SH-NCD-STATS
-
OSPF NSR packet library statistics
- rib-thread-stats: OSPFV3-EDM-RTHREAD-STATS
-
OSPFv3 RIB thread statistics
Example
{
"issu-stats": {
"nsr-lsa-qad-mdata-count": "integer",
"nsr-nbr-init-sync-pend-count": "string",
"nsr-mtu": "integer",
"nsr-nbr-qad-mdata-count": "integer",
"nsr-conn-to-active-closes": "integer",
"nsr-conn-to-active-errors": "integer",
"nsr-nbr-seq-no": "integer",
"nsr-conn-to-active-opens": "integer",
"nsr-issu-milestone": [
{
"milestone-name": "string",
"milestone-status": "string"
}
],
"nsr-version": "integer",
"nsr-intf-seq-no": "integer",
"nsr-tmr-quant": "string",
"nsr-fsm-running-timer": [
"string"
],
"nsr-lsa-init-sync-pend-count": "string",
"nsr-peer-node-id": "integer",
"nsr-fsm-flag": [
"string"
],
"nsr-conn-to-active-attempts": "integer",
"nsr-conn-to-active-fails": "integer",
"nsr-peer-version": "integer",
"nsr-thd-stats": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-rtr-thd-sched": {
"nsr-pulse-quant": "string",
"nsr-events-rx": "integer",
"nsr-good-pulses-rx": "integer",
"nsr-bad-pulses-rx": "integer",
"nsr-events-in-q": "integer",
"nsr-pri": [
{
"nsr-sched-evs-qd": "integer",
"nsr-sched-pri": "string",
"nsr-sched-max-evs": "integer",
"nsr-sched-evs-in-q": "integer",
"nsr-sched-evs-deqd": "integer",
"nsr-sched-peak-q-len": "integer",
"nsr-sched-remain-quant": "integer",
"nsr-sched-quant": "integer",
"nsr-sched-enq-fails": "integer"
}
],
"nsr-pulse-tx-fails": "integer",
"nsr-events-tx": "integer",
"nsr-pulses-tx": "integer"
},
"nsr-revision": "string",
"nsr-node-id": "integer",
"nsr-lsa-qad-qid": "integer",
"nsr-nbr-qad-qid": "integer",
"nsr-err-history": [
{
"nsr-error-info": [
{
"last-err-time": {
"second": "integer"
}
}
]
}
]
},
"vrf-rib-batch-stats": {
"batches-sent": "integer",
"paths-add-errs": "integer",
"paths-add": "integer",
"routes-pending": "integer",
"paths-pending": "integer",
"paths-sent": "integer",
"routes-sent": "integer",
"max-routes": "integer",
"paths-del-errs": "integer",
"paths-del": "integer"
}
}